GetClickFrame

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Flavors
war within  mainline  cata  wrath  vanilla
Links
Wowprogramming  GitHub Search
Info
Added in 3.0.2 / 1.13.2

Returns the frame registered with the given object name.

frame = GetClickFrame(name)

Arguments

name

string - The name of the frame to obtain.

Returns

frame

table? - The table handle to the named frame if it exists, else nil.

Details

• This function acts as a secure cache for frame name to object lookups. The first call to this function will cache the frame object registered assigned to name in the global namespace, and all subsequent calls thereafter will return the same frame even if the global is later replaced.
• This function will not cache frame objects if the queried name does not match their actual object name as returned by UIObject:GetName().
• If called securely, this function returns the frame to the caller untainted.

Patch changes

Patch 2.4.3 (2008-07-15): Added.