C_PetBattles.CanPetSwapIn

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
Links
GitHub Search
Info
Added in 5.0.4

Returns whether or not the pet can swap in to the active position.

usable = C_PetBattles.CanPetSwapIn(petIndex)

Arguments

petIndex

number - Accepted values are 1-3, but the order is based off of the initial order. Which pet is currently active is irrelevant to the index, if it was your 3rd pet when you entered battle, it will always be 3 on the index.

Returns

usable

boolean - True if the pet is able to swap in, false otherwise.

Patch changes

Patch 5.0.4 (2012-08-28): Added.

See also

• C_PetBattles.CanActivePetSwapOut - Tells you if the current pet can be swapped out
• C_PetBattles.ChangePet - Change to another pet
• C_PetBattles.GetActivePet - Get the index of the current pet
• Pet Battle Functions