Back to index...

NameTypeDeprecatedSecureDescription
abilityAn ability, represented by a standard identifier with an 'a' prefix.
achievementAn achievement, represented by a standard identifier with a 'c' prefix.
achievementcategoryAn achievement category, represented by a standard identifier with a 'C' prefix.
auctionAn auction, represented by a standard identifier with an 'o' prefix.
booleanA value of type 'boolean'.
buffA buff, represented by a standard identifier with a 'b' prefix.
callbackfunctionA callback function, used to signal success or failure. Must be a function that takes two paramet...
consoleA text console, represented by a standard ID with a 'v' prefix.
currencycategoryA currency category, represented by a standard identifier with a 'N' prefix.
dimensionitemA dimension item, represented by a standard identifier with a 'd' prefix.
dumpfunctionDebug utility function. Similar to print(), but serializes any table parameters before outputting.
errorAn error, represented by a standard ID with an 'x' prefix.
eventFrameA frame event handle.
eventGlobalA global event handle.
factionA faction, represented by a standard ID with an 'f' prefix.
frameEventTableA frame event table of a UI element.
functionA value of type 'function'.
function/nilA value of type "function" or "nil".
function/stringA value of type "function" or "string".
function/string/nilA value of type "function", "string", or "nil".
guildrankA guild rank, represented by a standard identifier with a 'k' prefix.
guildwallA guild wall ID, represented by a standard identifier with a 'w' prefix.
handleEventFrameA handle for active frame events. Includes the member :GetTarget(), which returns the target fram...
handleEventGlobalA handle for active global events. Currently contains no members.
itemAn item, represented by either a standard identifier with an 'i' prefix or a slot.
itemtypeAn item type, represented by a nonstandard identifier with an 'I' prefix.
locationA map location, represented by a nonstandard identifier with an 'l' prefix.
mailA mail, represented by a standard identifier with an 'm' prefix.
nilA value of type 'nil'.
numberA value of type 'number'. May not be NaN.
number/nilA value of type 'number' or 'nil'. May not be NaN.
questA quest, represented by a standard identifier with a 'q' prefix.
roleA role, represented by a standard identifier with a "h" prefix.
slotAn item slot, represented by a nonstandard identifier with an 's' prefix, as generated by the Uti...
stringA value of type 'string'.
string/nilA value of type 'string' or 'nil'.
tableA value of type 'table'.
titleA title, represented by a standard identifier with a 't' prefix.
titlecategoryA title category, represented by a standard identifier with a 'T' prefix.
unitA unit, represented by either a standard identifier with a 'u' prefix or by a unit specifier. Uni...
variantA value of any type.
zoneA zone, represented by a standard identifier with a 'z' prefix.

ability

An ability, represented by a standard identifier with an 'a' prefix.

achievement

An achievement, represented by a standard identifier with a 'c' prefix.

achievementcategory

An achievement category, represented by a standard identifier with a 'C' prefix.

auction

An auction, represented by a standard identifier with an 'o' prefix.

boolean

A value of type 'boolean'.

buff

A buff, represented by a standard identifier with a 'b' prefix.

callbackfunction

A callback function, used to signal success or failure. Must be a function that takes two parameters, "failure" and "message". On success, "failure" will be false or nil. Otherwise, "failure" will be either a computer-readable string identifier or true. "message" may contain a human-readable message that may be delivered to the user.

console

A text console, represented by a standard ID with a 'v' prefix.

currencycategory

A currency category, represented by a standard identifier with a 'N' prefix.

dimensionitem

A dimension item, represented by a standard identifier with a 'd' prefix.

dump

Debug utility function. Similar to print(), but serializes any table parameters before outputting.

Usage:

dump(...)
ParameterTypeDatatypeDescription
...parameter...Takes any number of any parameter type.

error

An error, represented by a standard ID with an 'x' prefix.

eventFrame

A frame event handle.

eventGlobal

A global event handle.

faction

A faction, represented by a standard ID with an 'f' prefix.

frameEventTable

A frame event table of a UI element.

function

A value of type 'function'.

function/nil

A value of type "function" or "nil".

function/string

A value of type "function" or "string".

function/string/nil

A value of type "function", "string", or "nil".

guildrank

A guild rank, represented by a standard identifier with a 'k' prefix.

guildwall

A guild wall ID, represented by a standard identifier with a 'w' prefix.

handleEventFrame

A handle for active frame events. Includes the member :GetTarget(), which returns the target frame of this event. If being passed to a .Dive handler, also includes :Halt() and :Catch(). :Halt() halts propogation of the event through the hierarchy and, after finishing the current frame's .Dive handlers, immediately begins processing .Bubble events. :Catch() works similarly but processes main events before continuing to .Bubble. Neither function may be called when the environment is in secure mode and either the current or target frame has a restricted secure mode.

handleEventGlobal

A handle for active global events. Currently contains no members.

item

An item, represented by either a standard identifier with an 'i' prefix or a slot.

itemtype

An item type, represented by a nonstandard identifier with an 'I' prefix.

location

A map location, represented by a nonstandard identifier with an 'l' prefix.

mail

A mail, represented by a standard identifier with an 'm' prefix.

nil

A value of type 'nil'.

number

A value of type 'number'. May not be NaN.

number/nil

A value of type 'number' or 'nil'. May not be NaN.

quest

A quest, represented by a standard identifier with a 'q' prefix.

role

A role, represented by a standard identifier with a "h" prefix.

slot

An item slot, represented by a nonstandard identifier with an 's' prefix, as generated by the Utility.Item.Slot.* functions.

string

A value of type 'string'.

string/nil

A value of type 'string' or 'nil'.

table

A value of type 'table'.

title

A title, represented by a standard identifier with a 't' prefix.

titlecategory

A title category, represented by a standard identifier with a 'T' prefix.

types

string
true
buff
true
callbackfunction
true
number/nil
true
role
true
table
true
Native
true
Context
true
Texture
true
location
true
Text
true
boolean
true
ability
true
zone
true
RiftButton
true
Element
true
handleEventGlobal
true
title
true
RiftWindow
true
achievementcategory
true
Frame
true
auction
true
RiftScrollbar
true
number
true
RiftTextfield
true
achievement
true
eventGlobal
true
currencycategory
true
Mask
true
Layout
true
unit
true
function
true
string/nil
true
titlecategory
true
variant
true
RiftCheckbox
true
frameEventTable
true
quest
true
handleEventFrame
true
function/string
true
dimensionitem
true
nil
true
slot
true
guildrank
true
function/nil
true
eventFrame
true
item
true
guildwall
true
itemtype
true
function/string/nil
true
faction
true
mail
true
RiftSlider
true
error
true
console
true

unit

A unit, represented by either a standard identifier with a 'u' prefix or by a unit specifier. Unit specifiers start with any of "player", "focus", "mouseover", "group01" through "group20", or a standard identifier with a 'u' prefix, and are followed by a chain of any number of ".target", ".pet", or ".owner" modifiers.

variant

A value of any type.

zone

A zone, represented by a standard identifier with a 'z' prefix.

Back to index...