ScriptRegion
object type55 methodsavailable in: camelot
It has every method of Object, plus 55 of its own.
Inherits from
- ScriptRegion · 55
- Object · 5
- FrameScriptObject · 21
The number is each type's own documented methods. A ScriptRegion has all of them.
Methods
In the emulator: 38 implemented, 5 recorded, 12 guessed.
| method | what it does | status |
|---|---|---|
CanChangeProtectedState | Returns true if protected properties of the region can be changed by non-secure scripts. · warcraft.wiki.gg ↗(): boolean | recorded |
CanPropagateMouseClicks | Whether mouse clicks on the region pass on to the frames under it. · by wowlua(): boolean | guessed |
CanPropagateMouseMotion | Whether mouse movement over the region passes on to the frames under it. · by wowlua(): boolean | guessed |
ClearScripts | Remove all script handlers set through Scripts in XML or SetScript in Lua · warcraft.wiki.gg ↗() | implemented |
CollapsesLayout | Whether the region takes up no space in its parent's layout while hidden. · by wowlua(): boolean | guessed |
EnableMouse | Sets whether the region should receive mouse input. · warcraft.wiki.gg ↗(enable: boolean) | implemented |
EnableMouseMotion | Sets whether the region should receive mouse hover events. · warcraft.wiki.gg ↗(enable: boolean) | implemented |
EnableMouseWheel | Sets whether the region should receive mouse wheel input. · warcraft.wiki.gg ↗(enable: boolean) | implemented |
FocusEnter | Runs the region's mouse enter behaviour as if the cursor entered it. It is protected; Blizzard's gamepad navigation uses it. · by wowlua(fromMouseMotion: boolean) | guessed |
FocusExit | Runs the region's mouse leave behaviour as if the cursor left it. It is protected; Blizzard's gamepad navigation uses it. · by wowlua(fromMouseMotion: boolean) | guessed |
GetBottom | Returns the distance of the region's bottom edge from the bottom of the screen. · by wowlua(): number? | implemented |
GetCenter | Returns the screen coordinates of the region's center. · by wowlua(): (number?, number?) | implemented |
GetHeight | Returns the region's height. · by wowlua(ignoreRect: boolean): number | implemented |
GetLeft | Returns the offset of the named part of the region from the bottom left of the screen (game window), the offset is in the effective scale of the region. · warcraft.wiki.gg ↗(): number? | implemented |
GetRect | Returns the coords and size of the region. · warcraft.wiki.gg ↗(): (number?, number?, number?, number?) | implemented |
GetRight | Returns the distance of the region's right edge from the left of the screen. · by wowlua(): number? | implemented |
GetRoundLayoutToNearestPixel | Returns whether the region's layout is rounded to the nearest pixel. · by wowlua(): boolean | guessed |
GetScaledRect | Returns the region's left, bottom, width and height in screen coordinates, with its effective scale applied. · by wowlua(): (number?, number?, number?, number?) | guessed |
GetScript | Returns the widget script handler. · warcraft.wiki.gg ↗(scriptTypeName: ScriptTypeName, bindingType: ScriptBindingType): LuaFunctionReference | implemented |
GetSize | Returns the size of the region. · warcraft.wiki.gg ↗(ignoreRect: boolean): (number, number) | implemented |
GetSourceLocation | Returns the script name and line number where the region was created. · warcraft.wiki.gg ↗(): string | guessed |
GetTop | Returns the distance of the region's top edge from the bottom of the screen. · by wowlua(): number? | implemented |
GetWidth | Returns the region's width. · by wowlua(ignoreRect: boolean): number | implemented |
HasScript | Returns true if the region supports the given script type. · warcraft.wiki.gg ↗(scriptName: string): boolean | implemented |
Hide | Hides the region. · warcraft.wiki.gg ↗() | implemented |
HookScript | Securely post-hooks a widget script handler. · warcraft.wiki.gg ↗(scriptTypeName: ScriptTypeName, script: LuaFunctionReference, bindingType: ScriptBindingType): boolean | implemented |
Intersects | Whether the region overlaps another region on screen. · by wowlua(region: ScriptRegion): boolean | guessed |
IsAnchoringRestricted | Returns true if the region has cross-region anchoring restrictions applied. · warcraft.wiki.gg ↗(): boolean | implemented |
IsAnchoringSecret | Whether the region's position depends on a secret value, so addons cannot read it. · by wowlua(): boolean | implemented |
IsCollapsed | Whether the region is collapsed and takes up no space in its parent's layout. · by wowlua(): boolean | implemented |
IsDragging | Returns true if the region is being dragged. · warcraft.wiki.gg ↗(): boolean | implemented |
IsMouseClickEnabled | Returns true if the region can receive mouse clicks. · warcraft.wiki.gg ↗(): boolean | recorded |
IsMouseEnabled | Returns true if the region can receive mouse input. · warcraft.wiki.gg ↗(): boolean | recorded |
IsMouseMotionEnabled | Returns true if the region can receive mouse hover events. · warcraft.wiki.gg ↗(): boolean | recorded |
IsMouseMotionFocus | Returns true if the mouse cursor is hovering over the region. · warcraft.wiki.gg ↗(): boolean | implemented |
IsMouseOver | Returns true if the mouse cursor is hovering over the region. · warcraft.wiki.gg ↗(offsetTop: number, offsetBottom: number, offsetLeft: number, offsetRight: number): boolean | implemented |
IsMouseWheelEnabled | Returns true if the region can receive mouse wheel input. · warcraft.wiki.gg ↗(): boolean | recorded |
IsProtected | Returns whether the region is currently protected. · warcraft.wiki.gg ↗(): (boolean, boolean) | implemented |
IsRectValid | Returns true if the region can be positioned on the screen. · warcraft.wiki.gg ↗(): boolean | implemented |
IsShown | Returns whether the region (and its parents) are shown. · warcraft.wiki.gg ↗(): boolean | implemented |
IsVisible | Returns whether the region is visible. · warcraft.wiki.gg ↗(): boolean | implemented |
MouseDown | Presses a mouse button on the region, as if the player did. It is protected; Blizzard's gamepad navigation follows it with MouseUp to click. · by wowlua(button: string) | guessed |
MouseUp | Releases a mouse button on the region, as if the player did. It is protected. · by wowlua(button: string) | guessed |
SetCollapsesLayout | Sets whether the region takes up no space in its parent's layout while hidden. · by wowlua(collapsesLayout: boolean) | implemented |
SetMouseClickEnabled | Sets whether the region should receive mouse clicks. · warcraft.wiki.gg ↗(enabled: boolean) | implemented |
SetMouseMotionEnabled | Sets whether the region should receive mouse hover events. · warcraft.wiki.gg ↗(enabled: boolean) | implemented |
SetParent | Sets the parent of the region. · warcraft.wiki.gg ↗(parent: Frame?) | implemented |
SetPassThroughButtons | Allows the region to propagate mouse clicks to underlying regions or the world frame. · warcraft.wiki.gg ↗(buttons: MouseButton) | implemented |
SetPropagateMouseClicks | Controls whether click events will be passed through to the region immediately beneath this one. · warcraft.wiki.gg ↗(propagate: boolean) | implemented |
SetPropagateMouseMotion | Controls whether motion events will be passed through to the region immediately beneath this one. · warcraft.wiki.gg ↗(propagate: boolean) | implemented |
SetRoundLayoutToNearestPixel | Sets whether the region's layout is rounded to the nearest pixel. It is protected. · by wowlua(enabled: boolean) | implemented |
SetScript | Sets the widget script handler. · warcraft.wiki.gg ↗(scriptTypeName: ScriptTypeName, script: LuaFunctionReference?) | implemented |
SetShown | Shows or hides the region. · warcraft.wiki.gg ↗(show: boolean) | implemented |
ShouldButtonPassThrough | Whether clicks of the given mouse button pass through the region to the frames under it. · by wowlua(button: MouseButton): boolean | guessed |
Show | Shows the region. · warcraft.wiki.gg ↗() | 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.