We have moved to Warcraft Wiki. Click here for information and the new URL.

READ MORE

Advertisement

in: API functions, API functions/Protected

PickupCompanion

Revision as of 12:55, 1 March 2014 by Foxlit (talk | contribs) (Created page with "{{wowapi}} {{protectedcombatapi|3.0.2}} Places a companion onto the mouse cursor. PickupCompanion("type", index) == Arguments == ; type : String - companion type, either "MO...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Sign in to edit

Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards.

This function is protected, and cannot be called from insecure code while in in combat.

It has been protected since patch 3.0.2.

Places a companion onto the mouse 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 history

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

See also

Advertisement