GetAnimalCompanionName

From NWN Lexicon
Jump to navigationJump to search



GetAnimalCompanionName(object)

Gets a creature's animal companion's name.

string GetAnimalCompanionName(
    object oCreature
);

Parameters

oCreature

PC or NPC that may have a animal companion.

Description

Returns oCreature's animal companion's name.
Returns "" if oCreature is invalid, does not currently have an animal companion, or if the animal companion's name is blank.

Remarks

Returns no information for summoned creatures. Note that an animal companion is different from a familiar.

Version

1.29

See Also

functions: 

SummonAnimalCompanion, GetAnimalCompanionCreatureType



 author: Charles Feduke, editor: Jody Fletcher, additional contributor(s): Jody Fletcher, Gene Koo