Frame
widget type126 methodsavailable in: camelot
CreateFrame("Frame", …) makes one. It has every method of Region, plus 126 of its own.
Inherits from
- Frame · 126
- Region · 16
- ScriptRegion · 55
- ScriptRegionResizing · 13
- AnimatableObject · 3
- Object · 5
- FrameScriptObject · 21
The number is each type's own documented methods. A Frame has all of them.
Methods
In the emulator: 85 implemented, 13 recorded, 28 guessed.
| method | what it does | status |
|---|---|---|
AbortDrag | Stops the frame's current drag. · by wowlua() | guessed |
AddRoleset | Adds a roleset tag to this frame without removing existing ones. · warcraft.wiki.gg ↗(roleset: string) | guessed |
CanChangeAttribute | Whether the frame's attributes can be changed now. · by wowlua(): boolean | guessed |
ClearAlphaGradient | Removes the frame's alpha gradient. · by wowlua() | guessed |
ClearAttribute | Removes an attribute from the frame. · by wowlua(attributeName: string): boolean | guessed |
ClearAttributes | Removes all attributes from the frame. · by wowlua() | implemented |
CreateFontString | Creates a fontstring. · warcraft.wiki.gg ↗(name: string?, drawLayer: DrawLayer?, templateName: string?): FontString | implemented |
CreateLine | Draws a line. · warcraft.wiki.gg ↗(name: string?, drawLayer: DrawLayer?, templateName: string?, subLevel: number?): Line | implemented |
CreateMaskTexture | Creates a mask texture. · warcraft.wiki.gg ↗(name: string?, drawLayer: DrawLayer?, templateName: string?, subLevel: number?): MaskTexture | implemented |
CreateTexture | Creates a texture. · warcraft.wiki.gg ↗(name: string?, drawLayer: DrawLayer?, templateName: string?, subLevel: number?): Texture | implemented |
CreateVectorGraphics | Creates a vector graphics region on the frame, which can show an SVG image. · by wowlua(name: string?, drawLayer: DrawLayer?, templateName: string?, subLevel: number?): VectorGraphics | guessed |
DesaturateHierarchy | Desaturates the frame and all its children. · by wowlua(desaturation: number, excludeRoot: boolean) | guessed |
DisableDrawLayer | Prevents display of the frame on the specified draw layer. · warcraft.wiki.gg ↗(layer: DrawLayer) | guessed |
DoesClipChildren | Whether the frame clips its children to its own bounds. · by wowlua(): boolean | guessed |
DoesHyperlinkPropagateToParent | Returns whether hyperlink events (ex. OnHyperlinkEnter, OnHyperlinkLeave, OnHyperlinkClick) are propagated to this frame's parent. · warcraft.wiki.gg ↗(): boolean | guessed |
EnableDrawLayer | Allows display of the frame on the specified draw layer. · warcraft.wiki.gg ↗(layer: DrawLayer) | implemented |
EnableGamePadButton | Allows the receipt of gamepad button inputs for this frame. · warcraft.wiki.gg ↗(enable: boolean) | implemented |
EnableGamePadStick | Allows the receipt of gamepad stick inputs for this frame. · warcraft.wiki.gg ↗(enable: boolean) | implemented |
EnableKeyboard | Allows this frame to receive keyboard input. · warcraft.wiki.gg ↗(enable: boolean) | implemented |
ExecuteAttribute | Runs the snippet stored in the frame's attribute with the given arguments. · by wowlua(attributeName: string, arguments: string?): (boolean, string?) | implemented |
GetAlpha | Returns the frame's opacity. · warcraft.wiki.gg ↗(): number | implemented |
GetAttribute | Returns the value of a secure frame attribute. · warcraft.wiki.gg ↗(attributeName: string): string | implemented |
GetBoundsRect | Returns the calculated bounding box of the frame and all of its descendant regions. · warcraft.wiki.gg ↗(): (number, number, number, number) | guessed |
GetChildren | Returns a list of child frames belonging to the frame. · warcraft.wiki.gg ↗(): Frame | implemented |
GetClampRectInsets | Returns the frame's clamp rectangle offsets. · warcraft.wiki.gg ↗(): (number, number, number, number) | recorded |
GetDontSavePosition | Whether the game skips saving the frame's position. · by wowlua(): boolean | guessed |
GetEffectiveAlpha | Returns the region's effective opacity. · warcraft.wiki.gg ↗(): number | guessed |
GetEffectiveScale | Returns the effective scale after propagating from the parent region. · warcraft.wiki.gg ↗(): number | implemented |
GetEffectivelyFlattensRenderLayers | Returns true if render layer flattening has been implicitly enabled. · warcraft.wiki.gg ↗(): boolean | guessed |
GetFlattensRenderLayers | Returns true if render layer flattening has been enabled. · warcraft.wiki.gg ↗(): boolean | recorded |
GetFrameLevel | Returns the frame level of the frame. · warcraft.wiki.gg ↗(): number | implemented |
GetFrameStrata | Returns the layering strata of the frame. · warcraft.wiki.gg ↗(): FrameStrata | guessed |
GetHighestFrameLevel | Returns the highest framelevel of the frame and its first order children, or all children if iterateAllChildren is true. · warcraft.wiki.gg ↗(iterateAllChildren: boolean): number | guessed |
GetHitRectInsets | Returns the insets of the frame's hit rectangle. · warcraft.wiki.gg ↗(): (number, number, number, number) | recorded |
GetHyperlinksEnabled | Returns true if mouse interaction with hyperlinks on the frame is enabled. · warcraft.wiki.gg ↗(): boolean | guessed |
GetID | Returns the frame's numeric identifier. · warcraft.wiki.gg ↗(): number | implemented |
GetNumChildren | Returns the number of child frames belonging to the frame. · warcraft.wiki.gg ↗(): number | implemented |
GetNumRegions | Returns the number of non-Frame child regions belonging to the frame. · warcraft.wiki.gg ↗(): number | recorded |
GetOnUpdateMode | Returns the currently configured OnUpdate script execution mode. · warcraft.wiki.gg ↗(): OnUpdateMode | guessed |
GetPropagateKeyboardInput | Returns whether the frame propagates keyboard events. · warcraft.wiki.gg ↗(): boolean | implemented |
GetRaisedFrameLevel | Returns the frame's raised frame level. · by wowlua(): number | guessed |
GetRegions | Returns a list of non-Frame child regions belonging to the frame. · warcraft.wiki.gg ↗(): Region | implemented |
GetResizeBounds | Returns the minimum and maximum size of the frame for user resizing. · warcraft.wiki.gg ↗(): (number, number, number, number) | implemented |
GetRolesetNames | Returns the roleset tags assigned to this frame. Returns a list containing 'roleless' if none are assigned. · warcraft.wiki.gg ↗(): string[] | guessed |
GetScale | Returns the scale of the frame. · warcraft.wiki.gg ↗(): number | implemented |
GetWindow | Returns the window the frame belongs to. · by wowlua(): Window | guessed |
HasAlphaGradient | Whether the frame has an alpha gradient. · by wowlua(): boolean | guessed |
HasFixedFrameLevel | Whether the frame's level is fixed, so it does not follow its parent's. · by wowlua(): boolean | recorded |
HasFixedFrameStrata | Whether the frame's strata is fixed, so it does not follow its parent's. · by wowlua(): boolean | recorded |
Hide | Hides the frame. · by wowlua() | implemented |
InterceptStartDrag | Lets another frame take over a drag that starts on this frame. · by wowlua(delegate: Frame): boolean | guessed |
IsClampedToScreen | Returns whether a frame is prevented from being moved off-screen. · warcraft.wiki.gg ↗(): boolean | recorded |
IsDrawLayerEnabled | Whether the frame draws the given layer. · by wowlua(layer: DrawLayer): boolean | implemented |
IsEventRegistered | Returns whether a frame is registered to an event. · warcraft.wiki.gg ↗(eventName: string): (boolean, string?) | implemented |
IsFrameBuffer | Whether the frame renders through a frame buffer. · by wowlua(): boolean | implemented |
IsGamePadButtonEnabled | Checks if this frame is configured to receive gamepad button inputs. · warcraft.wiki.gg ↗(): boolean | implemented |
IsGamePadStickEnabled | Checks if this frame is configured to receive gamepad stick inputs. · warcraft.wiki.gg ↗(): boolean | implemented |
IsHighlightLocked | Whether the frame's highlight is locked on. · by wowlua(): boolean | implemented |
IsIgnoringChildrenForBounds | Whether the frame leaves its children out of its bounds. · by wowlua(): boolean | implemented |
IsIgnoringParentAlpha | Whether the frame ignores its parent's alpha. · by wowlua(): boolean | implemented |
IsIgnoringParentScale | Whether the frame ignores its parent's scale. · by wowlua(): boolean | implemented |
IsKeyboardEnabled | Returns true if keyboard interactivity is enabled for the frame. · warcraft.wiki.gg ↗(): boolean | recorded |
IsMovable | Returns true if the frame is movable. · warcraft.wiki.gg ↗(): boolean | recorded |
IsObjectLoaded | Whether the frame's object has finished loading. · by wowlua(): boolean | recorded |
IsResizable | Returns true if the frame can be resized by the user. · warcraft.wiki.gg ↗(): boolean | recorded |
IsRolesetFiltered | Returns whether this frame is hidden because of its rolesets being filtered. · warcraft.wiki.gg ↗(): boolean | implemented |
IsShown | Whether the frame is set to be shown, whether or not its parents are visible. · by wowlua(): boolean | implemented |
IsToplevel | Returns whether this frame should raise its frame level on mouse interaction. · warcraft.wiki.gg ↗(): boolean | recorded |
IsUserPlaced | Returns whether the frame has been moved by the user. · warcraft.wiki.gg ↗(): boolean | recorded |
IsUsingParentLevel | Whether the frame takes its frame level from its parent. · by wowlua(): boolean | implemented |
IsVisible | Whether the frame and all its parents are shown. · by wowlua(): boolean | implemented |
LockHighlight | Sets the frame or button to always be drawn highlighted. · warcraft.wiki.gg ↗() | implemented |
Lower | Reduces the frame's frame level below all other frames in its strata. · warcraft.wiki.gg ↗() | implemented |
Raise | Increases the frame's frame level above all other frames in its strata · warcraft.wiki.gg ↗() | implemented |
RegisterAllEvents | Flags the frame to receive all events. · warcraft.wiki.gg ↗() | implemented |
RegisterEvent | Registers the frame to an event. · warcraft.wiki.gg ↗(eventName: string): boolean | implemented |
RegisterEventCallback | Registers a function the frame calls when the event fires. · by wowlua(eventName: string, cb: FrameEventCallbackType): boolean | implemented |
RegisterForDrag | Registers the frame for dragging with a mouse button. · warcraft.wiki.gg ↗(buttons: MouseButton) | implemented |
RegisterUnitEvent | Registers the frame for a specific event, triggering only for the specified units. · warcraft.wiki.gg ↗(eventName: string, units: string): boolean | implemented |
RegisterUnitEventCallback | Registers a function the frame calls when the event fires for one of the given units. · by wowlua(eventName: string, cb: FrameEventCallbackType, units: string): boolean | guessed |
RemoveRoleset | Removes a roleset tag from this frame. · warcraft.wiki.gg ↗(roleset: string) | guessed |
ResizeToBoundsRect | Addon-safe API for resizing a frame to match the bounds of its children. · warcraft.wiki.gg ↗() | guessed |
RotateTextures | Rotates the frame's textures by the given angle around a point. · by wowlua(radians: number, x: number, y: number) | guessed |
SetAlpha | Sets the opacity of the frame. · warcraft.wiki.gg ↗(alpha: number) | implemented |
SetAlphaFromBoolean | Sets the frame's opacity to one of two values depending on a boolean, which may be a secret. Blizzard's code notes that tainted callers must use it instead of SetShown for secret values. · by wowlua(value: boolean, alphaIfTrue: number, alphaIfFalse: number) | implemented |
SetAlphaGradient | Configures a frame to perform an alpha gradient fade on its edges. · warcraft.wiki.gg ↗(index: number, gradient: Vector2DMixin) | guessed |
SetAttribute | Sets an attribute on the frame. · warcraft.wiki.gg ↗(attributeName: string, value: string) | implemented |
SetAttributeNoHandler | Sets an attribute on the frame without triggering the OnAttributeChanged script. · warcraft.wiki.gg ↗(attributeName: string, value: string) | implemented |
SetClampRectInsets | Controls how much of the frame may be moved off-screen. · warcraft.wiki.gg ↗(left: number, right: number, top: number, bottom: number) | implemented |
SetClampedToScreen | Prevents the frame from moving off-screen. · warcraft.wiki.gg ↗(clampedToScreen: boolean) | implemented |
SetClipsChildren | Sets whether the frame clips its children to its own bounds. · by wowlua(clipsChildren: boolean) | implemented |
SetDontSavePosition | Sets whether the game skips saving the frame's position. · by wowlua(dontSave: boolean) | implemented |
SetDrawLayerEnabled | Turns drawing of a layer on or off for the frame. · by wowlua(layer: DrawLayer, isEnabled: boolean) | implemented |
SetFixedFrameLevel | Sets whether the frame's level is fixed, so it does not follow its parent's. · by wowlua(isFixed: boolean) | implemented |
SetFixedFrameStrata | Sets whether the frame's strata is fixed, so it does not follow its parent's. · by wowlua(isFixed: boolean) | implemented |
SetFlattensRenderLayers | Controls whether all subregions are composited into a single render layer. · warcraft.wiki.gg ↗(flatten: boolean) | implemented |
SetFrameLevel | Sets the level at which the frame is layered relative to others in its strata. · warcraft.wiki.gg ↗(frameLevel: number) | implemented |
SetFrameStrata | Sets the layering strata of the frame. · warcraft.wiki.gg ↗(strata: FrameStrata) | implemented |
SetHighlightLocked | Sets whether the frame's highlight stays on. · by wowlua(locked: boolean) | implemented |
SetHitRectInsets | Sets the insets of the frame's hit rectangle. · warcraft.wiki.gg ↗(left: number, right: number, top: number, bottom: number) | implemented |
SetHyperlinkPropagateToParent | Enables or disables propagating hyperlink events (ex. OnHyperlinkEnter, OnHyperlinkLeave, OnHyperlinkClick) to this frame's parent. · warcraft.wiki.gg ↗(canPropagate: boolean) | implemented |
SetHyperlinksEnabled | Allows mouse interaction with hyperlinks on the frame. · warcraft.wiki.gg ↗(enabled: boolean) | implemented |
SetID | Sets a numeric identifier for the frame. · warcraft.wiki.gg ↗(id: number) | implemented |
SetIgnoreParentAlpha | Sets whether the frame ignores its parent's alpha. · by wowlua(ignore: boolean) | implemented |
SetIgnoreParentScale | Sets whether the frame ignores its parent's scale. · by wowlua(ignore: boolean) | implemented |
SetIgnoringChildrenForBounds | Sets whether the frame leaves its children out of its bounds. · by wowlua(ignore: boolean) | implemented |
SetIsFrameBuffer | Controls whether or not a frame is rendered to its own framebuffer prior to being composited atop the UI. · warcraft.wiki.gg ↗(isFrameBuffer: boolean) | implemented |
SetMovable | Sets whether the frame can be moved. · warcraft.wiki.gg ↗(movable: boolean) | implemented |
SetOnUpdateMode | Changes when OnUpdate scripts are executed for this object. · warcraft.wiki.gg ↗(onUpdateMode: OnUpdateMode) | implemented |
SetPropagateKeyboardInput | Sets whether keyboard input is consumed by this frame or propagates to further frames. · warcraft.wiki.gg ↗(propagate: boolean) | implemented |
SetResizable | Sets whether the frame can be resized by the user. · warcraft.wiki.gg ↗(resizable: boolean) | implemented |
SetResizeBounds | Sets the minimum and maximum size of the frame for user resizing. · warcraft.wiki.gg ↗(minWidth: number, minHeight: number, maxWidth: number?, maxHeight: number?) | implemented |
SetRolesets | Sets the roleset tags for this frame, used by the UI mode system to gate visibility. Supports comma-separated names to assign multiple rolesets. Pass nil to clear. · warcraft.wiki.gg ↗(rolesetsString: string?) | implemented |
SetScale | Sets the size scaling of the frame. · warcraft.wiki.gg ↗(scale: number) | implemented |
SetShown | Shows or hides the frame. · by wowlua(shown: boolean) | implemented |
SetToplevel | Controls whether or not a frame should raise its frame level on mouse interaction. · warcraft.wiki.gg ↗(topLevel: boolean) | implemented |
SetUserPlaced | Sets whether a frame has been moved by the user and will be saved in the layout cache. · warcraft.wiki.gg ↗(userPlaced: boolean) | implemented |
SetUsingParentLevel | Sets whether the frame takes its frame level from its parent. · by wowlua(usingParentLevel: boolean) | implemented |
SetWindow | Sets the window the frame belongs to. · by wowlua(window: Window?) | implemented |
Show | Shows the frame. · by wowlua() | implemented |
StartMoving | Begins repositioning the frame via mouse movement. · warcraft.wiki.gg ↗(alwaysStartFromMouse: boolean) | implemented |
StartSizing | Begins resizing the frame via mouse movement. · warcraft.wiki.gg ↗(resizePoint: FramePoint?, alwaysStartFromMouse: boolean) | implemented |
StopMovingOrSizing | Stops moving or resizing the frame, and anchors the point that is closest to a UIParent point to that. · warcraft.wiki.gg ↗() | implemented |
UnlockHighlight | Sets the frame or button to not always be drawn highlighted. · warcraft.wiki.gg ↗() | implemented |
UnregisterAllEvents | Unregisters all events from the frame. · warcraft.wiki.gg ↗() | implemented |
UnregisterEvent | Unregisters an event from the frame. · warcraft.wiki.gg ↗(eventName: string): boolean | implemented |
sources
Methods and inheritance: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.