Defined Methods
Inherited Methods
- ScenarioPOIFrame:AllowAttributeChanges() - Temporarily allows insecure code to modify the frame's attributes during combat
- enabled = ScenarioPOIFrame:CanChangeAttribute() - Returns whether secure frame attributes can currently be changed
- canChange = ScenarioPOIFrame:CanChangeProtectedState() - Returns whether protected properties of the region can be changed by non-secure scripts
- ScenarioPOIFrame:ClearAllPoints() - Removes all anchor points from the region
- animationGroup = ScenarioPOIFrame:CreateAnimationGroup(["name" [, "inheritsFrom"]]) - Creates a new AnimationGroup as a child of the region
- fontstring = ScenarioPOIFrame:CreateFontString(["name" [, "layer" [, "inherits"]]]) - Creates a new [[docs/widgets/FontString|`FontString`]] as a child of the frame
- texture = ScenarioPOIFrame:CreateTexture(["name" [, "layer" [, "inherits" [, sublevel]]]]) - Creates a new [[docs/widgets/Texture|`Texture`]] as a child of the frame
- region = ScenarioPOIFrame:CreateTitleRegion() - Creates a title region for dragging the frame
- ScenarioPOIFrame:DisableDrawLayer("layer") - Prevents display of all child objects of the frame on a specified graphics layer
- ScenarioPOIFrame:EnableDrawLayer("layer") - Allows display of all child objects of the frame on a specified graphics layer
- ScenarioPOIFrame:EnableJoystick(enable) - Enables or disables joystick interactivity
- ScenarioPOIFrame:EnableKeyboard(enable) - Enables or disables keyboard interactivity for the frame
- ScenarioPOIFrame:EnableMouse(enable) - Enables or disables mouse interactivity for the frame
- ScenarioPOIFrame:EnableMouseWheel(enable) - Enables or disables mouse wheel interactivity for the frame
- alpha = ScenarioPOIFrame:GetAlpha() - Returns the opacity of the region relative to its parent
- ... = ScenarioPOIFrame:GetAnimationGroups() - Returns a list of animation groups belonging to the region
- value = ScenarioPOIFrame:GetAttribute("name") - Returns the value of a secure frame attribute
- backdrop = ScenarioPOIFrame:GetBackdrop() - Returns information about the frame's backdrop graphic
- red, green, blue, alpha = ScenarioPOIFrame:GetBackdropBorderColor() - Returns the shading color for the frame's border graphic
- red, green, blue, alpha = ScenarioPOIFrame:GetBackdropColor() - Returns the shading color for the frame's background graphic
- bottom = ScenarioPOIFrame:GetBottom() - Returns the distance from the bottom of the screen to the bottom of the region
- left, bottom, width, height = ScenarioPOIFrame:GetBoundsRect() - Returns the position and dimension of the smallest area enclosing the frame and its children
- x, y = ScenarioPOIFrame:GetCenter() - Returns the screen coordinates of the region's center
- ... = ScenarioPOIFrame:GetChildren() - Returns a list of child frames of the frame
- left, right, top, bottom = ScenarioPOIFrame:GetClampRectInsets() - Returns offsets from the frame's edges used when limiting user movement or resizing of the frame
- depth = ScenarioPOIFrame:GetDepth() - Returns the 3D depth of the frame (for stereoscopic 3D setups)
- ScenarioPOIFrame:GetDontSavePosition() - This function is not yet documented
- alpha = ScenarioPOIFrame:GetEffectiveAlpha() - Returns the overall opacity of the frame
- depth = ScenarioPOIFrame:GetEffectiveDepth() - Returns the overall 3D depth of the frame (for stereoscopic 3D configurations)
- scale = ScenarioPOIFrame:GetEffectiveScale() - Returns the overall scale factor of the frame
- level = ScenarioPOIFrame:GetFrameLevel() - Sets the level at which the frame is layered relative to others in its strata
- strata = ScenarioPOIFrame:GetFrameStrata() - Returns the general layering strata of the frame
- height = ScenarioPOIFrame:GetHeight() - Returns the height of the region
- left, right, top, bottom = ScenarioPOIFrame:GetHitRectInsets() - Returns the insets from the frame's edges which determine its mouse-interactable area
- id = ScenarioPOIFrame:GetID() - Returns the frame's numeric identifier
- left = ScenarioPOIFrame:GetLeft() - Returns the distance from the left edge of the screen to the left edge of the region
- maxWidth, maxHeight = ScenarioPOIFrame:GetMaxResize() - Returns the maximum size of the frame for user resizing
- minWidth, minHeight = ScenarioPOIFrame:GetMinResize() - Returns the minimum size of the frame for user resizing
- name = ScenarioPOIFrame:GetName() - Returns the widget object's name
- numChildren = ScenarioPOIFrame:GetNumChildren() - Returns the number of child frames belonging to the frame
- numPoints = ScenarioPOIFrame:GetNumPoints() - Returns the number of anchor points defined for the region
- numRegions = ScenarioPOIFrame:GetNumRegions() - Returns the number of non-Frame child regions belonging to the frame
- type = ScenarioPOIFrame:GetObjectType() - Returns the object's widget type
- parent = ScenarioPOIFrame:GetParent() - Returns the object's parent object
- point, relativeTo, relativePoint, xOffset, yOffset = ScenarioPOIFrame:GetPoint(index) - Returns information about one of the region's anchor points
- ScenarioPOIFrame:GetPropagateKeyboardInput() - This function is not yet documented
- left, bottom, width, height = ScenarioPOIFrame:GetRect() - Returns the position and dimensions of the region
- ... = ScenarioPOIFrame:GetRegions() - Returns a list of non-Frame child regions belonging to the frame
- right = ScenarioPOIFrame:GetRight() - Returns the distance from the left edge of the screen to the right edge of the region
- scale = ScenarioPOIFrame:GetScale() - Returns the frame's scale factor
- handler = ScenarioPOIFrame:GetScript("scriptType") - Returns the widget's handler function for a script
- width, height = ScenarioPOIFrame:GetSize() - Returns the width and height of the region
- region = ScenarioPOIFrame:GetTitleRegion() - Returns the frame's TitleRegion object
- top = ScenarioPOIFrame:GetTop() - Returns the distance from the bottom of the screen to the top of the region
- width = ScenarioPOIFrame:GetWidth() - Returns the width of the region
- hasScript = ScenarioPOIFrame:HasScript("scriptType") - Returns whether the widget supports a script handler
- ScenarioPOIFrame:Hide() - Hides the region
- ScenarioPOIFrame:HookScript("scriptType", handler) - Securely hooks a script handler
- ScenarioPOIFrame:IgnoreDepth(enable) - Sets whether the frame's depth property is ignored (for stereoscopic 3D setups)
- enabled = ScenarioPOIFrame:IsClampedToScreen() - Returns whether the frame's boundaries are limited to those of the screen
- isDragging = ScenarioPOIFrame:IsDragging() - Returns whether the region is currently being dragged
- registered = ScenarioPOIFrame:IsEventRegistered("event") - Returns whether the frame is registered for a given [[docs/events|event]]
- enabled = ScenarioPOIFrame:IsIgnoringDepth() - Returns whether the frame's depth property is ignored (for stereoscopic 3D setups)
- enabled = ScenarioPOIFrame:IsJoystickEnabled() - Returns whether joystick interactivity is enabled for the frame
- enabled = ScenarioPOIFrame:IsKeyboardEnabled() - Returns whether keyboard interactivity is enabled for the frame
- enabled = ScenarioPOIFrame:IsMouseEnabled() - Returns whether mouse interactivity is enabled for the frame
- isOver = ScenarioPOIFrame:IsMouseOver([topOffset [, leftOffset [, bottomOffset [, rightOffset]]]]) - Returns whether the mouse cursor is over the given region
- enabled = ScenarioPOIFrame:IsMouseWheelEnabled() - Returns whether mouse wheel interactivity is enabled for the frame
- movable = ScenarioPOIFrame:IsMovable() - Returns whether the frame can be moved by the user
- isType = ScenarioPOIFrame:IsObjectType("type") - Returns whether the object belongs to a given widget type
- isProtected, explicit = ScenarioPOIFrame:IsProtected() - Returns whether the region is protected
- enabled = ScenarioPOIFrame:IsResizable() - Returns whether the frame can be resized by the user
- shown = ScenarioPOIFrame:IsShown() - Returns whether the region is shown
- enabled = ScenarioPOIFrame:IsToplevel() - Returns whether the frame is automatically raised to the front when clicked
- enabled = ScenarioPOIFrame:IsUserPlaced() - Returns whether the frame is flagged for automatic saving and restoration of position and dimensions
- visible = ScenarioPOIFrame:IsVisible() - Returns whether the region is visible
- ScenarioPOIFrame:Lower() - Reduces the frame's frame level below all other frames in its strata
- ScenarioPOIFrame:Raise() - Increases the frame's frame level above all other frames in its strata
- ScenarioPOIFrame:RegisterAllEvents() - Registers the frame for all events
- ScenarioPOIFrame:RegisterEvent("event") - Registers the frame for an [[docs/events|event]]
- ScenarioPOIFrame:RegisterForDrag(...) - Registers the frame for dragging
- ScenarioPOIFrame:RegisterUnitEvent() - This function is not yet documented
- ScenarioPOIFrame:SetAllPoints([region]) or ScenarioPOIFrame:SetAllPoints(["name"]) - Sets all anchor points of the region to match those of another region
- ScenarioPOIFrame:SetAlpha(alpha) - Sets the opacity of the region relative to its parent
- ScenarioPOIFrame:SetAttribute("name", value) - Sets a secure frame attribute
- ScenarioPOIFrame:SetBackdrop(backdrop) - Sets a backdrop graphic for the frame
- ScenarioPOIFrame:SetBackdropBorderColor(red, green, blue [, alpha]) - Sets a shading color for the frame's border graphic
- ScenarioPOIFrame:SetBackdropColor(red, green, blue [, alpha]) - Sets a shading color for the frame's background graphic
- ScenarioPOIFrame:SetClampRectInsets(left, right, top, bottom) - Sets offsets from the frame's edges used when limiting user movement or resizing of the frame
- ScenarioPOIFrame:SetClampedToScreen(enable) - Sets whether the frame's boundaries should be limited to those of the screen
- ScenarioPOIFrame:SetDepth(depth) - Sets the 3D depth of the frame (for stereoscopic 3D configurations)
- ScenarioPOIFrame:SetDontSavePosition() - This function is not yet documented
- ScenarioPOIFrame:SetFrameLevel(level) - Sets the level at which the frame is layered relative to others in its strata
- ScenarioPOIFrame:SetFrameStrata("strata") - Sets the general layering strata of the frame
- ScenarioPOIFrame:SetHeight(height) - Sets the region's height
- ScenarioPOIFrame:SetHitRectInsets(left, right, top, bottom) - Sets the insets from the frame's edges which determine its mouse-interactable area
- ScenarioPOIFrame:SetID(id) - Sets a numeric identifier for the frame
- ScenarioPOIFrame:SetMaxResize(maxWidth, maxHeight) - Sets the maximum size of the frame for user resizing
- ScenarioPOIFrame:SetMinResize(minWidth, minHeight) - Sets the minimum size of the frame for user resizing
- ScenarioPOIFrame:SetMovable(enable) - Sets whether the frame can be moved by the user
- ScenarioPOIFrame:SetParent(frame) or ScenarioPOIFrame:SetParent("name") - Makes another frame the parent of this region
- ScenarioPOIFrame:SetPoint("point" [, relativeTo [, "relativePoint" [, xOffset [, yOffset]]]]) - Sets an anchor point for the region
- ScenarioPOIFrame:SetPropagateKeyboardInput() - This function is not yet documented
- ScenarioPOIFrame:SetResizable(enable) - Sets whether the frame can be resized by the user
- ScenarioPOIFrame:SetScale(scale) - Sets the frame's scale factor
- ScenarioPOIFrame:SetScript("scriptType", handler) - Sets the widget's handler function for a script
- ScenarioPOIFrame:SetShown() - This function is not yet documented
- ScenarioPOIFrame:SetSize(width, height) - Sets the size of the region to the specified values
- ScenarioPOIFrame:SetToplevel(enable) - Sets whether the frame should automatically come to the front when clicked
- ScenarioPOIFrame:SetUserPlaced(enable) - Flags the frame for automatic saving and restoration of position and dimensions
- ScenarioPOIFrame:SetWidth(width) - Sets the region's width
- ScenarioPOIFrame:Show() - Shows the region
- ScenarioPOIFrame:StartMoving() - Begins repositioning the frame via mouse movement
- ScenarioPOIFrame:StartSizing() - Begins resizing the frame via mouse movement
- ScenarioPOIFrame:StopAnimating() - Stops any active animations involving the region or its children
- ScenarioPOIFrame:StopMovingOrSizing() - Ends movement or resizing of the frame initiated with [[docs/widgets/Frame/StartMoving|`:StartMoving()`]] or [[docs/widgets/Frame/StartSizing|`:StartSizing()`]]
- ScenarioPOIFrame:UnregisterAllEvents() - Unregisters the frame from any [[docs/events|events]] for which it is registered
- ScenarioPOIFrame:UnregisterEvent("event") - Unregisters the frame for an event
Script Handlers
- OnAttributeChanged(self, "name", value) - Run when a frame attribute is changed
- OnChar(self, "text") - Run for each text character typed in the frame
- OnDisable(self) - Run when the frame is disabled
- OnDragStart(self, "button") - Run when the mouse is dragged starting in the frame
- OnDragStop(self) - Run when the mouse button is released after a drag started in the frame
- OnEnable(self) - Run when the frame is enabled
- OnEnter(self, motion) - Run when the mouse cursor enters the frame's interactive area
- OnEvent(self, "event", ...) - Run whenever an [[docs/events|event]] fires for which the frame is registered
- OnHide(self) - Run when the frame's visbility changes to hidden
- OnKeyDown(self, "key") - Run when a keyboard key is pressed if the frame is keyboard enabled
- OnKeyUp(self, "key") - Run when a keyboard key is released if the frame is keyboard enabled
- OnLeave(self, motion) - Run when the mouse cursor leaves the frame's interactive area
- OnLoad(self) - Run when the frame is created
- OnMouseDown(self, "button") - Run when a mouse button is pressed while the cursor is over the frame
- OnMouseUp(self, "button") - Run when the mouse button is released following a mouse down action in the frame
- OnMouseWheel(self, delta) - Run when the frame receives a mouse wheel scrolling action
- OnReceiveDrag(self) - Run when the mouse button is released after dragging into the frame
- OnShow(self) - Run when the frame becomes visible
- OnSizeChanged(self, width, height) - Run when a frame's size changes
- OnUpdate(self, elapsed) - Run each time the screen is drawn by the game engine
