Api/doc

Creates a link to a specific API function or event page with the appropriate label.

• The first unnamed parameter must start with a properly formatted name (such as UnitAura or UIObject:GetName) but may also include:
  • For function/method arguments, (arguments) using round brackets
  • For event payloads, : payload using a colon
  • For XML attributes, attr1. attr2. attr3.val3 using a single space before each attribute and decimal after, and optionally specifying a value right after the decimal
• The second unnamed parameter is used in the second half of a wiki link, but arguments, payloads, attributes, etc. are still added using the first unnamed parameter.

Runtime API

See also: API, Widget API

Functions (a or default)

Truncates API from the title, colours arguments

{{api|UnitAura(unit, index [, filter])}}

UnitAura(unit, index [, filter])

Events (e)

Colours the payload

{{api|PLAYER_ENTERING_WORLD: isInitialLogin, isReloadingUi|t=e}}

PLAYER_ENTERING_WORLD → isInitialLogin, isReloadingUi

CVars (c)

Links to the CVar page

{{api|farclip|t=c}}

farclip

Widgets (o)

Links to the UIOBJECT page

{{api|Frame|t=o}}

Frame

Widget methods (w or wm)

Truncates API from the title, reformats :, colours arguments

{{api|Texture:SetTexture("filename" or fileID[, "horizWrap"[, "vertWrap"[, "filterMode"]]])|t=w}}

Texture:SetTexture("filename" or fileID[, "horizWrap"[, "vertWrap"[, "filterMode"]]])

Widget handlers (wh)

Links to the UIHANDLER page

{{api|OnClick|t=wh}}

OnClick

XML elements

See also: XML

Start tag (x)

Wraps the tag with < >

{{api|Frame hidden.true frameStrata.LOW|t=x}}

<Frame hidden="true" frameStrata="LOW">

End tag (/x)

Wraps the tag with </ >

{{api|Button name.$parentButton text.|t=/x}}

</Button name="$parentButton" text="">

No children (x/)

Wraps the tag with < />

{{api|Frame|t=x/}}

<Frame />

API Types

See also: API types

Basic types (t or t?)

Coloured orange, but not a hyperlink, and use t? to add optional/nilable question mark and tooltip

{{api|nil|t=t}}, {{api|Boolean|t=t}}, {{api|numBER|t=t}}, {{api|STRING|t=t}}, etc.

nil, boolean, number?Optional. Could be nil., string?Optional. Could be nil., etc.

Complex types (t or t?)

Shortens the name for Constants, Enumerations and Structs, but otherwise makes an ordinary blue or red hyperlink to the page

{{api|Enum Club.ClubType|t=t}}, {{api|itemLink|t=t?}}

Enum.ClubType, itemLink?Optional. Could be nil.

Expandable table to show values (table)

Creates a pretend blue link that actually expands into a table transcluding the target page

{{api|Enum Club.ClubType|t=table}}