API GetNumCompanions

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 < GetNumCompanions

Returns the number of companions you have. New in Patch 3.0

count = GetNumCompanions("type")

Arguments

type 

String (companionType) - Type of companions to count ("CRITTER", or "MOUNT")

Returns

count 

Number - The number of companions of a specific type.

Example

The following snippet prints how many mini-pets the player has collected.

local count = GetNumCompanions("CRITTER");
print('Hello, I have collected a total of ' .. count .. ' pets.');