GetFamiliarName

From NWN Lexicon



Contents

[edit] GetFamiliarName(object)

Get a creature's animal companion name.

string GetFamiliarName(
    object oCreature
);

[edit] Parameters

oCreature

PC or NPC that may have an Animal Companion.


[edit] 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.



[edit] Remarks

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


[edit] Known Bugs

GetAnimalCompanion* and GetFamiliar* functions are reversed - GetAnimalCompanion* returns for Sorcerer and Wizard familiars and GetFamiliar* returns for Ranger and Druid animal companions.


[edit] Version

1.29

[edit] See Also

functions: 

SummonFamiliar



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

Personal tools
Categories