GetFamiliarCreatureType

From NWN Lexicon



Contents

[edit] GetFamiliarCreatureType(object)

Gets the PC's animal companion creature type.

int GetFamiliarCreatureType(
    object oCreature
);

[edit] Parameters

oCreature

The PC who has an animal companion.


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



[edit] Remarks

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

This function returns the type of familiar that can be summoned, not the type of familiar that is currently summoned, so you can't use this to determine if a familiar has been summoned or not.

If oCreature is possessing the familiar when this function is called, it will return FAMILIAR_TYPE_NONE. Presumably this is because a possessed familiar can't summon 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.61

[edit] See Also

functions: 

SummonFamiliar

constants: 

ANIMAL_COMPANION_CREATURE_TYPE_* Constants



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

Personal tools
Categories