WoW:API CallCompanion: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(boilerplate)
m (Move page script moved page API CallCompanion to API CallCompanion without leaving a redirect)
 
(2 intermediate revisions by 2 users not shown)
Line 4: Line 4:


==Arguments==
==Arguments==
;type : String - The type of companion to summon or dismiss ("CRITTER", or "MOUNT").
;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).
;id : Integer - The companion index to summon or dismiss (ascending integers starting from 1).


Line 12: Line 12:
The following macro summons a random critter your character has acquired:
The following macro summons a random critter your character has acquired:
  /run CallCompanion("CRITTER", random(GetNumCompanions("CRITTER")))
  /run CallCompanion("CRITTER", random(GetNumCompanions("CRITTER")))
Note that there is an API call to do exactly that, see [[API_SummonRandomCritter]]

Latest revision as of 04:45, 15 August 2023

WoW API < CallCompanion

Summons the specified companion. New in Patch 3.0

CallCompanion("type", id)

Arguments[edit]

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[edit]

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