GetFamiliarName

From NWN Lexicon
Jump to navigationJump to search



GetFamiliarName(object)

Get a creature's familiar's name.

string GetFamiliarName(
    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.

Version

1.29

See Also

functions: 

SummonFamiliar, GetFamiliarCreatureType



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