PickupCompanion

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

Places a mount onto the cursor.

PickupCompanion(type, index)

Arguments

type

string - companion type, either "MOUNT" or "CRITTER".

index

number - index of the companion of the specified type to place on the cursor, ascending from 1.

Details

• You should only use this function to pick up mounts; for critters, this function has been superseded by C_PetJournal.PickupPet, and instead places an unusable spell on the cursor.

Patch changes

Patch 5.0.4 (2012-08-28): "CRITTER" pick-up broken.
Patch 3.0.2 (2008-10-14): Added.

See also

• GetCursorInfo
• GetCompanionInfo
• C_PetJournal.PickupPet