Template:Api

Creates a link to a specific API element. Mark API actual pages with Template:widget, Template:wowapi, Template:attrtype. See shorthand templates Template:apif, Template:apiwidget, Template:xml, Template:xmlattr. See Template:id for list links that need a page #section reference.

Usage

• 1 - name of the api
• 2 - alternate link display text. Default is same as name of the api
• 3 - parameter list. Default is not displaying parameters.
• t - type of api. Default is 'api'. Options:
  • a|api - API function, other WoW API well-known global, member, or method

    Function -> API Function|Function

    Name.member -> API Global member|Global.member

    Name:Method -> API Global Method|Global:Method

  • f|func - API function but showing ellipses and parameters
  • t|type - API TYPE
  • e|event - Event
  • c|cvar - CVAR
  • w|widget - UIOBJECT widget or widget method or other member

    Widget -> UIObject Widget|Widget

    Widget.member -> API Widget member|Widget.member

    Widget:Method -> API Widget Method|Widget:Method

  • m|macro - MACRO
  • x|xml - XML
  • xa|xmlattr - XML attributes

Examples

API

• {{api|Quit}} : Quit
• {{api|Quit|t=f}} : Quit() - params
• {{api|AuctionFrameAuctions.duration}} : AuctionFrameAuctions.duration - global member
• {{api|C_EquipmentSet.UseEquipmentSet}} : C_EquipmentSet.UseEquipmentSet
• {{api|C_EquipmentSet.UseEquipmentSet||equipmentSetID|t=f}} :
  C_EquipmentSet.UseEquipmentSet(equipmentSetID)

Event

• {{api|PLAYER_LOGIN|t=e}} : PLAYER_LOGIN

CVar

• {{api|farclip|t=c}} : farclip

Widget

• {{api|Texture|t=w}} : Texture - UIObject / Lua side widget
• {{api|Texture:SetTexture|t=w}} : Texture:SetTexture - method

Type

• {{api|string|t=t}} : string

Macro

• {{api|wargame|t=m}} : wargame

XML

• {{api|LayoutFrame|t=x}} : LayoutFrame
• {{api|name|t=xa}} : name

---

Template