GetAnimalCompanionName(object)

Gets a creature's familiar name.

string GetAnimalCompanionName(
    object oCreature
);

Parameters

oCreature

PC or NPC that may have a familiar.

Description

Returns oCreature's familiar's name.
Returns "" if oCreature is invalid, does not currently have a familiar, or if the familiar's name is blank.

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