CallCompanion

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Flavors
war within  mainline  cata  wrath  vanilla
Links
Wowprogramming  GitHub Search
Info
Added in 3.0.2 / 1.15.0

Summons a companion.

CallCompanion(type, id)

Arguments

type

string - The type of companion to summon or dismiss: "CRITTER" or "MOUNT".

id

number - The companion index to summon or dismiss, ascending from 1.

Example

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

/run CallCompanion("MOUNT",1)

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

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

Details

• The list of companions is usually, but not always, alphabetically sorted. You may not rely on the indices to remain stable, even if the number of companions is not altered.

Patch changes

Patch 5.0.4 (2012-08-28): Companions are now account-wide. This function only works for non-combat companions (battle pets) your character had acquired before the account-wide merge, as well as all mounts. For summoning battle pets, use the C_PetJournal API.
Patch 3.0.2 (2008-10-14): Added.

See also

• GetNumCompanions
• GetCompanionInfo