Update
Update Update Update Update Update Update Update Update Update
This commit is contained in:
236
ui/Frame.lua
236
ui/Frame.lua
@@ -1,76 +1,184 @@
|
||||
---@meta
|
||||
|
||||
---Frame is in many ways the most fundamental widget object. Other types of widget derivatives such as FontStrings, Textures and Animations can only be created attached to a Frame or other derivative of a Frame. Frames provide the basis for interaction with the user, and registering and responding to game events.
|
||||
---
|
||||
---When an addon needs to respond to game events or state changes and needs no visible components, this is typically accomplished using a Frame. Visibly, widgets that display game information such as threat or cooldowns and aren't directly interactive beyond being draggable are typically Frames. They are also commonly used as ways to group other related frames, either visibly (such as the way the Talents pane groups the buttons representing your character's talents) or invisibly (such as the way MultiBarRight groups twelve action buttons).
|
||||
---
|
||||
---You create a plain frame by specifying "Frame" as the first argument to CreateFrame, or with a <Frame> element in an XML file:
|
||||
---
|
||||
---- Create a new frame in Lua
|
||||
---
|
||||
--- local self = CreateFrame("Frame", "FunWidget", UIParent)
|
||||
---
|
||||
--- <Frame name="FunWidget" parent="UIParent">
|
||||
--- <!-- insert anchors, scripts, children and other components here in XML -->
|
||||
--- </Frame>
|
||||
---
|
||||
---Frames in the FrameXML include the action bars (the frames that group the action buttons together), the panels that display information like your character status and quest log, and the grand-daddy of the rest of the UI, UIParent.
|
||||
---@class Frame : UIObject
|
||||
---@class Frame : Region
|
||||
Frame = {
|
||||
---Sets whether the frame should automatically come to the front when clicked. When a frame with Toplevel behavior enabled is clicked, it automatically changes its frame level such that it is greater than (and therefore drawn "in front of") all other frames in its strata.
|
||||
---@param self Frame
|
||||
---@param enable boolean True to cause the frame to automatically come to the front when clicked; false otherwise
|
||||
SetTopLevel = function(self, enable) end,
|
||||
--- Aborts the current drag operation.
|
||||
--- @example
|
||||
--- myFrame:AbortDrag()
|
||||
AbortDrag = function(self) end,
|
||||
|
||||
---Flags the frame for automatic saving and restoration of position and dimensions. The position and size of frames so flagged is automatically saved when the UI is shut down (as when quitting, logging out, or reloading) and restored when the UI next starts up (as when logging in or reloading). If the frame does not have a name (set at creation time) specified, its position will not be saved. As implied by its name, enabling this property is useful for frames which can be moved or resized by the user.
|
||||
---
|
||||
---This function is automatically called with the value true when frame:StartMoving() is called.
|
||||
---
|
||||
---In order for the saved position to be applied to the frame in later sessions, the frame must have been made movable with frame:SetMovable(true).
|
||||
---@param self Frame
|
||||
---@param enable boolean True to enable automatic saving and restoration of the frame's position and dimensions; false to disable
|
||||
SetUserPlaced = function(self, enable) end,
|
||||
--- Returns true if secure frame attributes can be changed.
|
||||
--- @return boolean canChange True if attributes can be changed.
|
||||
--- @example
|
||||
--- local canChange = myFrame:CanChangeAttribute()
|
||||
CanChangeAttribute = function(self) end,
|
||||
|
||||
---Begins repositioning the frame via mouse movement.
|
||||
---@param self Frame
|
||||
--- Creates and returns a FontString as a child of this Frame.
|
||||
--- @param name string? Optional. The name of the FontString.
|
||||
--- @param layer string? Optional. The layer of the FontString.
|
||||
--- @param inheritsFrom string? Optional. The name of the FontString to inherit from.
|
||||
--- @return FontString fontString The created FontString.
|
||||
--- @example
|
||||
--- local myFontString = myFrame:CreateFontString("MyFontString", "OVERLAY")
|
||||
CreateFontString = function(self, name, layer, inheritsFrom) end,
|
||||
|
||||
--- Creates a mask texture.
|
||||
--- @param name string? Optional. The name of the mask texture.
|
||||
--- @param drawLayer string? Optional. The layer to draw the mask texture.
|
||||
--- @param templateName string? Optional. The name of a template to use.
|
||||
--- @param subLevel number? Optional. The sublevel of the mask texture.
|
||||
--- @return Texture The created mask texture.
|
||||
--- @example
|
||||
--- local maskTexture = myFrame:CreateMaskTexture(nil, "OVERLAY", "MaskTemplate")
|
||||
CreateMaskTexture = function(self, name, drawLayer, templateName, subLevel) end,
|
||||
|
||||
--- Creates and returns a Texture as a child of this Frame.
|
||||
--- @param name string? Optional. The name of the Texture.
|
||||
--- @param layer string? Optional. The layer of the Texture.
|
||||
--- @param inheritsFrom string? Optional. The name of the Texture to inherit from.
|
||||
--- @return Texture texture The created Texture.
|
||||
--- @example
|
||||
--- local myTexture = myFrame:CreateTexture("MyTexture", "BACKGROUND")
|
||||
CreateTexture = function(self, name, layer, inheritsFrom) end,
|
||||
|
||||
--- Disables drawing on the specified layer.
|
||||
--- @param layer string The layer to disable.
|
||||
--- @example
|
||||
--- myFrame:DisableDrawLayer("BACKGROUND")
|
||||
DisableDrawLayer = function(self, layer) end,
|
||||
|
||||
--- Enables drawing on the specified layer.
|
||||
--- @param layer string The layer to enable.
|
||||
--- @example
|
||||
--- myFrame:EnableDrawLayer("BACKGROUND")
|
||||
EnableDrawLayer = function(self, layer) end,
|
||||
|
||||
--- Sets the opacity of the frame.
|
||||
--- @param alpha number The opacity value (0 to 1).
|
||||
--- @example
|
||||
--- myFrame:SetAlpha(0.5) -- Set to 50% opacity
|
||||
SetAlpha = function(self, alpha) end,
|
||||
|
||||
--- Returns the frame's numeric identifier.
|
||||
--- @return number id The frame's ID.
|
||||
--- @example
|
||||
--- local id = myFrame:GetID()
|
||||
GetID = function(self) end,
|
||||
|
||||
--- Shows this object (it will appear if its parent is visible).
|
||||
--- @example
|
||||
--- myFrame:Show()
|
||||
Show = function(self) end,
|
||||
|
||||
--- Hides this object (it and all of its children will disappear).
|
||||
--- @example
|
||||
--- myFrame:Hide()
|
||||
Hide = function(self) end,
|
||||
|
||||
--- Starts moving the frame via mouse movement.
|
||||
--- @example
|
||||
--- myFrame:StartMoving()
|
||||
StartMoving = function(self) end,
|
||||
|
||||
---Begins resizing the frame via mouse movement.
|
||||
---@param self Frame
|
||||
StartSizing = function(self) end,
|
||||
|
||||
---Ends movement or resizing of the frame initiated with :StartMoving() or :StartSizing().
|
||||
---@param self Frame
|
||||
--- Stops moving the frame.
|
||||
--- @example
|
||||
--- myFrame:StopMovingOrSizing()
|
||||
StopMovingOrSizing = function(self) end,
|
||||
|
||||
---Unregisters the frame from any events for which it is registered.
|
||||
---@param self Frame
|
||||
UnregisterAllEvents = function(self) end,
|
||||
--- Sets whether the frame can be moved.
|
||||
--- @param movable boolean True to allow moving.
|
||||
--- @example
|
||||
--- myFrame:SetMovable(true)
|
||||
SetMovable = function(self, movable) end,
|
||||
|
||||
---Unregisters the frame for an event. Once unregistered, the frame's OnEvent script handler will not be called for that event.
|
||||
---
|
||||
---Unregistering from notifications for an event can be useful for improving addon performance at times when it's not necessary to process the event. For example, a frame which monitors target health does not need to receive the UNIT_HEALTH event while the player has no target. An addon that sorts the contents of the player's bags can register for the BAG_UPDATE event to keep track of when items are picked up, but unregister from the event while it performs its sorting.
|
||||
---@param self Frame
|
||||
---@param event string Name of an event
|
||||
UnregisterEvent = function(self, event) end,
|
||||
--- Sets the frame's level.
|
||||
--- @param level number The level to set.
|
||||
--- @example
|
||||
--- myFrame:SetFrameLevel(5)
|
||||
SetFrameLevel = function(self, level) end,
|
||||
|
||||
---Returns whether the mouse cursor is over the given region. This function replaces the previous MouseIsOver FrameXML function.
|
||||
---
|
||||
---If provided, the arguments are treated as offsets by which to adjust the hit rectangle when comparing it to the mouse. They are in screen coordinates; positive offsets move an edge right or up, negative values move it left or down. No frame edges are actually moved. For example:
|
||||
---
|
||||
--- if button:IsMouseOver(2, -2, -2, 2) then
|
||||
---
|
||||
---will return true if the mouse is within 2 pixels of the given frame.
|
||||
---@overload fun(self: Frame): boolean
|
||||
---@overload fun(self: Frame, topOffset: number): boolean
|
||||
---@overload fun(self: Frame, topOffset: number, leftOffset: number): boolean
|
||||
---@overload fun(self: Frame, topOffset: number, leftOffset: number, bottomOffset: number): boolean
|
||||
---@overload fun(self: Frame, topOffset: number, leftOffset: number, bottomOffset: number, rightOffset: number): boolean
|
||||
---@param self Frame
|
||||
---@param topOffset number The amount by which to displace the top edge of the test rectangle
|
||||
---@param leftOffset number The amount by which to displace the left edge of the test rectangle
|
||||
---@param bottomOffset number The amount by which to displace the bottom edge of the test rectangle
|
||||
---@param rightOffset number The amount by which to displace the right edge of the test rectangle
|
||||
---@return boolean isOver true if the mouse is over the region; otherwise false
|
||||
IsMouseOver = function(self, topOffset, leftOffset, bottomOffset, rightOffset) end,
|
||||
--- Sets the frame's strata.
|
||||
--- @param strata string The strata to set (e.g., "BACKGROUND", "MEDIUM", "HIGH").
|
||||
--- @example
|
||||
--- myFrame:SetFrameStrata("HIGH")
|
||||
SetFrameStrata = function(self, strata) end,
|
||||
|
||||
--- Registers the frame for a specific event.
|
||||
--- @param eventName string The name of the event to register.
|
||||
--- @example
|
||||
--- myFrame:RegisterEvent("PLAYER_LOGIN")
|
||||
RegisterEvent = function(self, eventName) end,
|
||||
|
||||
--- Unregisters an event from the frame.
|
||||
--- @param eventName string The name of the event to unregister.
|
||||
--- @example
|
||||
--- myFrame:UnregisterEvent("PLAYER_LOGIN")
|
||||
UnregisterEvent = function(self, eventName) end,
|
||||
|
||||
--- Sets the backdrop of the frame according to the specification provided.
|
||||
--- @param backdropTable table? Optional. A table defining the backdrop.
|
||||
--- @example
|
||||
--- myFrame:SetBackdrop({bgFile = "Interface\\DialogFrame\\UI-DialogBox-Background"})
|
||||
SetBackdrop = function(self, backdropTable) end,
|
||||
|
||||
--- Sets the frame's backdrop color.
|
||||
--- @param r number The red component of the color.
|
||||
--- @param g number The green component of the color.
|
||||
--- @param b number The blue component of the color.
|
||||
--- @param a number? Optional. The alpha component of the color.
|
||||
--- @example
|
||||
--- myFrame:SetBackdropColor(0, 0, 0, 0.5) -- Set to semi-transparent black
|
||||
SetBackdropColor = function(self, r, g, b, a) end,
|
||||
|
||||
--- Sets the frame's backdrop border color.
|
||||
--- @param r number The red component of the border color.
|
||||
--- @param g number The green component of the border color.
|
||||
--- @param b number The blue component of the border color.
|
||||
--- @param a number? Optional. The alpha component of the border color.
|
||||
--- @example
|
||||
--- myFrame:SetBackdropBorderColor(1, 1, 1) -- Set to white
|
||||
SetBackdropBorderColor = function(self, r, g, b, a) end,
|
||||
|
||||
--- Sets whether this frame will get keyboard input.
|
||||
--- @param enableFlag boolean True to enable keyboard input.
|
||||
--- @example
|
||||
--- myFrame:EnableKeyboard(true)
|
||||
EnableKeyboard = function(self, enableFlag) end,
|
||||
|
||||
--- Sets whether this frame will get mouse input.
|
||||
--- @param enableFlag boolean True to enable mouse input.
|
||||
--- @example
|
||||
--- myFrame:EnableMouse(true)
|
||||
EnableMouse = function(self, enableFlag) end,
|
||||
|
||||
--- Sets whether this frame will get mouse wheel notifications.
|
||||
--- @param enableFlag boolean True to enable mouse wheel notifications.
|
||||
--- @example
|
||||
--- myFrame:EnableMouseWheel(true)
|
||||
EnableMouseWheel = function(self, enableFlag) end,
|
||||
|
||||
--- Sets the height of the object.
|
||||
--- @param height number The height to set.
|
||||
--- @example
|
||||
--- myFrame:SetHeight(200)
|
||||
SetHeight = function(self, height) end,
|
||||
|
||||
--- Sets the width of the object.
|
||||
--- @param width number The width to set.
|
||||
--- @example
|
||||
--- myFrame:SetWidth(300)
|
||||
SetWidth = function(self, width) end,
|
||||
|
||||
--- Sets the size of the frame.
|
||||
--- @param width number The width to set.
|
||||
--- @param height number The height to set.
|
||||
--- @example
|
||||
--- myFrame:SetSize(300, 200)
|
||||
SetSize = function(self, width, height) end,
|
||||
|
||||
--- Sets the parent for this frame.
|
||||
--- @param parent Frame|string The parent frame or name of the parent frame.
|
||||
--- @example
|
||||
--- myFrame:SetParent(otherFrame)
|
||||
SetParent = function(self, parent) end,
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user