Advertisement
Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- Basic globals:
- Development.Documentation
- UI.CreateContext
- UI.CreateFrame
- _VERSION
- assert
- bit.arshift
- bit.band
- bit.bnot
- bit.bor
- bit.bswap
- bit.bxor
- bit.lshift
- bit.rol
- bit.ror
- bit.rshift
- bit.tobit
- bit.tohex
- collectgarbage
- coroutine.create
- coroutine.resume
- coroutine.running
- coroutine.status
- coroutine.wrap
- coroutine.yield
- debug.traceback
- error
- gcinfo
- getfenv
- getmetatable
- ipairs
- load
- loadstring
- math.abs
- math.acos
- math.asin
- math.atan
- math.atan2
- math.ceil
- math.cos
- math.cosh
- math.deg
- math.exp
- math.floor
- math.fmod
- math.frexp
- math.huge
- math.ldexp
- math.log
- math.log10
- math.max
- math.min
- math.mod
- math.modf
- math.pi
- math.pow
- math.rad
- math.random
- math.randomseed
- math.sin
- math.sinh
- math.sqrt
- math.tan
- math.tanh
- newproxy
- next
- pairs
- pcall
- print
- print_console
- rawequal
- rawget
- rawset
- select
- setfenv
- setmetatable
- string.byte
- string.char
- string.find
- string.format
- string.gfind
- string.gmatch
- string.gsub
- string.len
- string.lower
- string.match
- string.rep
- string.reverse
- string.sub
- string.upper
- table.concat
- table.foreach
- table.foreachi
- table.getn
- table.insert
- table.maxn
- table.remove
- table.sort
- tonumber
- tostring
- type
- unpack
- xpcall
- Inspectors:
- Inspect.Addon.Cpu
- Inspect.Addon.Current
- Inspect.Buff.Detail
- Inspect.Buff.List
- Inspect.System.Time
- Commands:
- Command.Buff.Cancel
- Command.Slash.Register
- Events:
- Event.Addon.Finalizing
- Event.Addon.Load.Begin
- Event.Addon.Load.End
- Event.Addon.SavedVariables.Load.Begin
- Event.Addon.SavedVariables.Load.End
- Event.Addon.SavedVariables.Save.Begin
- Event.Addon.SavedVariables.Save.End
- Event.Addon.Shutdown
- Event.Addon.Starting
- Event.Slash (empty category for dynamically-created events)
- Event.System.Error
- (1 handler)
- Event.System.Update.Begin
- Event.System.Update.End
- (1 handler)
- UI:
- Layout:
- Members:
- GetBottom
- GetBounds
- GetEventTable
- GetHeight
- GetLeft
- GetName
- GetOwner
- GetRight
- GetTop
- GetWidth
- Events:
- Move
- Size
- Frame: Inherits from Layout
- Members:
- GetAlpha
- GetBackgroundColor
- GetLayer
- GetParent
- GetVisible
- SetAllPoints
- SetAlpha
- SetBackgroundColor
- SetHeight
- SetLayer
- SetParent
- SetPoint
- SetVisible
- SetWidth
- Events:
- LeftDown
- LeftUp
- Context: Inherits from Frame
- Members:
- (No extra members)
- Events:
- (No extra events)
- Text: Inherits from Frame
- Members:
- GetFont
- GetFontColor
- GetFontSize
- GetFullHeight
- GetFullWidth
- GetText
- GetWordwrap
- ResizeToText
- SetFont
- SetFontColor
- SetFontSize
- SetText
- SetWordwrap
- Events:
- (No extra events)
- Texture: Inherits from Frame
- Members:
- GetTexture
- GetTextureHeight
- GetTextureWidth
- ResizeToTexture
- SetTexture
- Events:
- (No extra events)
- Basic globals:
- Development.Documentation
- Provide documentation on items in the addon environment. Called with no parameters, it returns a table listing all documentation. Can provide both human-readable and computer-readable documentation.
- documentables = Development.Documentation() -- table <- void
- documentation = Development.Documentation(item) -- string <- variant
- documentation = Development.Documentation(item, parseable = false) -- string <- variant, boolean
- documentationTable = Development.Documentation(item, parseable = true) -- table <- variant, boolean
- Parameters:
- parseable: Whether to return in a computer-readable format, as opposed to the normal human-readable format.
- item: The item to get documentation on. May be either the item itself or a string identifier.
- Results:
- documentables: List of all items that documentation can be retrieved for. In {["itemname"] = true} format.
- documentationTable: Computer-readable documentation for the requested item. Format may change without warning.
- documentation: Documentation for the requested item.
- UI.CreateContext
- Creates a new frame. Frames are the blocks that all addon UIs are made out of. Since all frames must have a parent, you'll need to create a Context before any frames. See UI.CreateContext.
- frame = UI.CreateFrame(type, name, parent) -- Frame <- string, string, Frame
- Parameters:
- name: A descriptive name for this element. Used for error reports and performance information. May be shown to end-users.
- parent: The new parent for this frame.
- type: The type of your new frame. Current supported types: Frame, Text, Texture.
- Results:
- frame: Your new frame.
- UI.CreateFrame
- Creates a new frame. Frames are the blocks that all addon UIs are made out of. Since all frames must have a parent, you'll need to create a Context before any frames. See UI.CreateContext.
- frame = UI.CreateFrame(type, name, parent) -- Frame <- string, string, Frame
- Parameters:
- name: A descriptive name for this element. Used for error reports and performance information. May be shown to end-users.
- parent: The new parent for this frame.
- type: The type of your new frame. Current supported types: Frame, Text, Texture.
- Results:
- frame: Your new frame.
- _VERSION
- assert
- bit.arshift
- bit.band
- bit.bnot
- bit.bor
- bit.bswap
- bit.bxor
- bit.lshift
- bit.rol
- bit.ror
- bit.rshift
- bit.tobit
- bit.tohex
- collectgarbage
- coroutine.create
- coroutine.resume
- coroutine.running
- coroutine.status
- coroutine.wrap
- coroutine.yield
- debug.traceback
- error
- gcinfo
- getfenv
- getmetatable
- ipairs
- load
- loadstring
- math.abs
- math.acos
- math.asin
- math.atan
- math.atan2
- math.ceil
- math.cos
- math.cosh
- math.deg
- math.exp
- math.floor
- math.fmod
- math.frexp
- math.huge
- math.ldexp
- math.log
- math.log10
- math.max
- math.min
- math.mod
- math.modf
- math.pi
- math.pow
- math.rad
- math.random
- math.randomseed
- math.sin
- math.sinh
- math.sqrt
- math.tan
- math.tanh
- newproxy
- next
- pairs
- pcall
- print
- print_console
- rawequal
- rawget
- rawset
- select
- setfenv
- setmetatable
- string.byte
- string.char
- string.find
- string.format
- string.gfind
- string.gmatch
- string.gsub
- string.len
- string.lower
- string.match
- string.rep
- string.reverse
- string.sub
- string.upper
- table.concat
- table.foreach
- table.foreachi
- table.getn
- table.insert
- table.maxn
- table.remove
- table.sort
- tonumber
- tostring
- type
- unpack
- xpcall
- Inspectors:
- Inspect.Addon.Cpu
- Returns recent CPU usage information. This is calculated using an exponential-falloff method.
- data = Inspect.Addon.Cpu() -- table <- void
- Results:
- data: Recent CPU usage. This takes the format { AddonIdentifier = { SubIdentifier = cpu_used_as_a_fraction_of_one } }. SubIdentifiers are generated by Rift and the format may change without notice.
- Inspect.Addon.Current
- Returns the current addon. This information is used internally for counting CPU usage and determining frame ownership.
- addonIdentifier = Inspect.Addon.Current() -- string <- void
- Results:
- addonIdentifier: The addon's identifier, as written in its TOC file.
- Inspect.Buff.Detail
- Provides detailed information about the buffs on a unit.
- detail = Inspect.Buff.Detail(unit, buff) -- table <- string, string
- details = Inspect.Buff.Detail(unit, buffs) -- table <- string, table
- Parameters:
- buff: An identifier for the buff to retrieve detail for.
- buffs: A table containing buff identifiers to retrieve details for.
- unit: The unit to inspect.
- Results:
- detail: Detail table for a single buff. May include members: name, ability, rune, buff, debuff, noncancelable, duration, remaining, expired, stack, caster.
- details: Detail tables for all requested buffs. The key is the buff ID, the value is the buff's detail table.
- Inspect.Buff.List
- List buffs on a unit.
- buffs = Inspect.Buff.List(unit) -- table <- string
- Parameters:
- unit: The unit to inspect.
- Results:
- buffs: List of IDs of the buffs on the unit.
- Inspect.System.Time
- A high-resolution timer.
- time = Inspect.System.Time() -- number <- void
- Results:
- time: Time in seconds. Counted from an arbitrary point in the past. Guaranteed to be non-negative.
- Commands:
- Command.Buff.Cancel
- Cancels a buff on the player. Not all buffs are cancelable.
- Command.Buff.Cancel(buff) -- string
- Parameters:
- buff: The ID of the buff to cancel.
- Command.Slash.Register
- Registers a new chat slash command, inserts a new event table into the Event.Slash hierarchy, and returns that table. If called multiple times with the same slash command, will return the same table each time.
- eventTable = Command.Slash.Register(slashCommand) -- table <- string
- Parameters:
- slashCommand: The name of the slash command to register.
- Results:
- eventTable: The event table for your slash command. nil if the slash command could not be registered (usually because it conflicts with a built-in slash command.)
- Events:
- Event.Addon.Finalizing
- Event.Addon.Load.Begin
- Event.Addon.Load.End
- Event.Addon.SavedVariables.Load.Begin
- Event.Addon.SavedVariables.Load.End
- Event.Addon.SavedVariables.Save.Begin
- Event.Addon.SavedVariables.Save.End
- Event.Addon.Shutdown
- Event.Addon.Starting
- Event.Slash (empty category for dynamically-created events)
- Event.System.Error
- (1 handler)
- Event.System.Update.Begin
- Event.System.Update.End
- (1 handler)
- UI:
- Layout:
- Members:
- GetBottom
- Retrieves the Y position of the bottom edge of this element.
- bottom = Layout:GetBottom() -- number <- void
- Results:
- bottom: The Y position of the bottom edge of this element.
- GetBounds
- Retrieves the complete bounds of this element.
- left, top, right, bottom = Layout:GetBounds() -- number, number, number, number <- void
- Results:
- right: The X position of the right edge of this element.
- left: The X position of the left edge of this element.
- bottom: The Y position of the bottom edge of this element.
- top: The Y position of the top edge of this element.
- GetEventTable
- Retrieves the event table of this element. By default, this value is also stored in "this.Event".
- eventTable = Layout:GetEventTable() -- table <- void
- Results:
- eventTable: The event table of this element.
- GetHeight
- Retrieves the height of this element.
- height = Layout:GetHeight() -- number <- void
- Results:
- height: The height of this element.
- GetLeft
- Retrieves the X position of the left edge of this element.
- left = Layout:GetLeft() -- number <- void
- Results:
- left: The X position of the left edge of this element.
- GetName
- Retrieves the name of this element.
- name = Layout:GetName() -- string <- void
- Results:
- name: The name of this element, as provided by the addon that created it.
- GetOwner
- Retrieves the owner of this element.
- owner = Layout:GetOwner() -- string <- void
- Results:
- owner: The owner of this element. Given as an addon identifier.
- GetRight
- Retrieves the X position of the right edge of this element.
- right = Layout:GetRight() -- number <- void
- Results:
- right: The X position of the right edge of this element.
- GetTop
- Retrieves the Y position of the top edge of this element.
- top = Layout:GetTop() -- number <- void
- Results:
- top: The Y position of the top edge of this element.
- GetWidth
- Retrieves the width of this element.
- width = Layout:GetWidth() -- number <- void
- Results:
- width: The width of this element.
- Events:
- Move
- Size
- Frame: Inherits from Layout
- Members:
- GetAlpha
- Gets the alpha multiplier of this frame.
- alpha = Frame:GetAlpha() -- number <- void
- Results:
- alpha: The alpha multiplier of this frame. 1 is fully opaque, 0 is fully transparent. This does not include multiplied alphas from this frame's parent - it's the exact value passed to SetAlpha.
- GetBackgroundColor
- Retrieves the background color of this frame.
- r, g, b, a = Frame:GetBackgroundColor() -- number, number, number, number <- void
- Results:
- b: Blue.
- r: Red.
- a: Alpha. 1 is fully opaque, 0 is fully transparent.
- g: Green.
- GetLayer
- Gets the frame's layer order.
- layer = Frame:GetLayer() -- number <- void
- Results:
- layer: The render layer of this frame. See Frame:SetLayer for details.
- GetParent
- Gets the parent of this frame.
- parent = Frame:GetParent() -- Frame <- void
- Results:
- parent: The parent element of this frame.
- GetVisible
- Gets the visibility flag for this frame.
- visible = Frame:GetVisible() -- boolean <- void
- Results:
- visible: This frame's visibility flag, as set by SetVisible. Does not check the visibility flags of the frame's parents.
- SetAllPoints
- Pins all the edges of this frame to the edges of a different frame.
- Frame:SetAllPoints(target) -- Layout
- Parameters:
- target: Target Layout to pin this frame's edges to.
- SetAlpha
- Sets the alpha transparency multiplier for this frame and its children.
- Frame:SetAlpha(alpha) -- number
- Parameters:
- alpha: The new alpha multiplier. 1 is fully opaque, 0 is fully transparent.
- SetBackgroundColor
- Sets the background color of this frame.
- Frame:SetBackgroundColor(r, g, b) -- number, number, number
- Frame:SetBackgroundColor(r, g, b, a) -- number, number, number, number
- Parameters:
- b: Blue.
- r: Red.
- a: Alpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
- g: Green.
- SetHeight
- Sets the height of this frame. Undefined results if the frame already has two pinned Y coordinates.
- Frame:SetHeight(height) -- number
- Parameters:
- height: The new height of this frame.
- SetLayer
- Sets the frame layer for this frame. This can be any number. Frames are drawn in ascending order. If two frames have the same layer number, then the order of those frames is undefined, but stable during a single play session. Frames are always drawn after their parents.
- Frame:SetLayer(layer) -- number
- Parameters:
- layer: The new layer for this frame.
- SetParent
- Sets the parent of this frame. Circular dependencies result in undefined behavior.
- Frame:SetParent(parent) -- Frame
- Parameters:
- parent: The new parent for this frame.
- SetPoint
- Pins a point on this frame to a location on another frame. This is a rather complex function and you should look at examples to see how to use it. Better documentation will be forthcoming.
- Frame:SetPoint(...) -- ...
- Parameters:
- ...: This function's parameters are complicated. More details will be forthcoming.
- SetVisible
- Sets the frame's visibility flag. If set to false, then this frame and all its children will not be rendered or accept mouse input.
- Frame:SetVisible(visible) -- boolean
- Parameters:
- visible: The new visibility flag.
- SetWidth
- Sets the width of this frame. Undefined results if the frame already has two pinned X coordinates.
- Frame:SetWidth(width) -- number
- Parameters:
- width: The new width of this frame.
- Events:
- LeftDown
- LeftUp
- Context: Inherits from Frame
- Members:
- (No extra members)
- Events:
- (No extra events)
- Text: Inherits from Frame
- Members:
- GetFont
- Gets the current font used for this element.
- source, font = Text:GetFont() -- string, string <- void
- Results:
- font: The actual font identifier. Either a resource identifier or a filename.
- source: The source of the resource. "Rift" will take the resource from Rift's internal data. Anything else will take the resource from the addon with that identifier.
- GetFontColor
- Gets the current font color for this element.
- r, g, b, a = Text:GetFontColor() -- number, number, number, number <- void
- Results:
- b: Blue.
- r: Red.
- a: Alpha. 1 is fully opaque, 0 is fully transparent.
- g: Green.
- GetFontSize
- Gets the font size of the current element.
- fontsize = Text:GetFontSize() -- number <- void
- Results:
- fontsize: The current font size of this element.
- GetFullHeight
- Get the height that would be required for this element to display all lines of text.
- height = Text:GetFullHeight() -- number <- void
- Results:
- height: The element height needed to display all lines of text.
- GetFullWidth
- Get the width that would be required for this element to avoid word wrapping or truncation.
- width = Text:GetFullWidth() -- number <- void
- Results:
- width: The element width needed to avoid word wrapping or truncation.
- GetText
- Get the current text for this element.
- text = Text:GetText() -- string <- void
- Results:
- text: The current text of the element.
- GetWordwrap
- Gets the wordwrap flag for this element.
- wordwrap = Text:GetWordwrap() -- boolean <- void
- Results:
- wordwrap: The current wordwrap flag for this element. If false, long lines will be truncated. Defaults to false.
- ResizeToText
- Sets the element's width and height to display all text without wordwrapping or truncation.
- Text:ResizeToText() -- void
- SetFont
- Sets the current font used for this element.
- Text:SetFont(source, font) -- string, string
- Parameters:
- font: The actual font identifier. Either a resource identifier or a filename.
- source: The source of the resource. "Rift" will take the resource from Rift's internal data. Anything else will take the resource from the addon with that identifier.
- SetFontColor
- Sets the current font color for this element.
- Text:SetFontColor(r, g, b) -- number, number, number
- Text:SetFontColor(r, g, b, a) -- number, number, number, number
- Parameters:
- b: Blue.
- r: Red.
- a: Alpha. 1 is fully opaque, 0 is fully transparent. Defaults to 1.
- g: Green.
- SetFontSize
- Sets the current font size of this element.
- Text:SetFontSize(fontsize) -- number
- Parameters:
- fontsize: The new font size of this element.
- SetText
- Sets the current text for this element.
- Text:SetText(text) -- string
- Parameters:
- text: The new text for the element.
- SetWordwrap
- Sets the wordwrap flag for this element.
- Text:SetWordwrap(wordwrap) -- boolean
- Parameters:
- wordwrap: The new wordwrap flag for this element. If false, long lines will be truncated. Defaults to false.
- Events:
- (No extra events)
- Texture: Inherits from Frame
- Members:
- GetTexture
- Gets the current texture used for this element.
- source, texture = Texture:GetTexture() -- string, string <- void
- Results:
- source: The source of the resource. "Rift" will take the resource from Rift's internal data. Anything else will take the resource from the addon with that identifier.
- texture: The actual texture identifier. Either a resource identifier or a filename.
- GetTextureHeight
- Returns the actual pixel height of the current texture.
- height = Texture:GetTextureHeight() -- number <- void
- Results:
- height: The height of the current texture in pixels.
- GetTextureWidth
- Returns the actual pixel width of the current texture.
- width = Texture:GetTextureWidth() -- number <- void
- Results:
- width: The width of the current texture in pixels.
- ResizeToTexture
- Sets the element's width and height to the exact pixel size of the texture.
- Texture:ResizeToTexture() -- void
- SetTexture
- Sets the current texture used for this element.
- Texture:SetTexture(source, texture) -- string, string
- Parameters:
- source: The source of the resource. "Rift" will take the resource from Rift's internal data. Anything else will take the resource from the addon with that identifier.
- texture: The actual texture identifier. Either a resource identifier or a filename.
- Events:
- (No extra events)
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement