WoW API: CallCompanion

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < CallCompanion

Summons the specified companion. New in Patch 3.0

CallCompanion("type", id)

Arguments

type

String (companionType) - The type of companion to summon or dismiss ("CRITTER", or "MOUNT").

id

Integer - The companion index to summon or dismiss (ascending integers starting from 1).

Example

The following macro summons the [alphabetically] first critter your character has acquired:

/run CallCompanion("CRITTER",1)

The following macro summons a random critter your character has acquired:

/run CallCompanion("CRITTER", random(GetNumCompanions("CRITTER")))

Note that there is an API call to do exactly that, see API_SummonRandomCritter