GetFamiliarCreatureType(object)
Gets the PC's animal companion creature type.
int GetFamiliarCreatureType( object oCreature );
Parameters
oCreature
The PC who has an animal companion.
Description
Returns oCreature's animal companion creature type (ANIMAL_COMPANION_CREATURE_TYPE_*).
Returns ANIMAL_COMPANION_CREATURE_TYPE_NONE if oCreature is invalid or does not currently have an animal companion.
Remarks
Returns no information for summoned creatures. Note that an animal companion is different from a familiar.
Known Bugs
GetAnimalCompanion* and GetFamiliar* functions are reversed - GetAnimalCompanion* returns for Sorcerer and Wizard familiars and GetFamiliar* returns for Ranger and Druid animal companions.
Version
1.29
See Also
author: Charles Feduke, editor: Jody Fletcher, additional contributor(s): Jody Fletcher, Gene Koo
Send comments on this topic.