Category:Henchmen Familiars Summoned Functions

From NWN Lexicon
Jump to: navigation, search

Henchmen/Familiars/Summoned Function Category

Functions used to deal with NPC henchmen, familiars, or summoned creatures.



Functions

Name Brief Description

ActionForceFollowObject

Forces an NPC to follow an object.

ActionUseSkill

Causes a creature to attempt to use a skill on another object.

AddHenchman

Adds a henchman NPC to a PC.

CheckIsUnlocked

Plays voice chat messages that indicates the locked status of a door or placeable.

ClearAssociateActions

Clear the actions of one of each type of the PC's associates

CopyLocals

Copies locals from earlier level henchmen to newer henchman

CreateBalor

Summons a Balor to fight for the caster

DestroyAllPersonalItems

Destroys all henchman items.

DestroyChapterQuestItem

Destroys the chapter specific quest item given to oPC by the henchman.

DestroyChapterRewardItem

Destroys the chapter specific reward item given to oPC by the henchman.

DoFollowMaster

Make the henchman approach its master if it is too far away, depending on the distance it has been asked to keep

DoLevelUp

Levels up an NPC to appropriate PC henchman level.

EffectSwarm

Returns a Swarm effect.

EquipAppropriateWeapons

Cause a creature to ready an appropriate weapon.

GetAnimalCompanionCreatureType

Get a creature's familiar creature type.

GetAnimalCompanionName

Gets a creature's familiar name.

GetAssociate

Returns an object's associate.

GetAssociateCRMax

GetAssociateHealMaster

GetAssociateStartLocation

Gets the start location of an NPC associate.

GetAssociateState

GetAssociateType

Returns the associate type of the specified creature

GetBeenHired

Checks if a henchman has been hired.

GetBehind

Causes the caller to move behind the player who is considered their Master.

GetCanLevelUp

Determines if an NPC henchman should level up.

GetCreatureStartingPackage

Returns the default level up package

GetDidDie

TRUE if the player has died.

GetFactionMostDamagedMember

Get the member of oFactionMember's faction that has taken the most hit points of damage.

GetFamiliarCreatureType

Gets the PC's animal companion creature type.

GetFamiliarName

Get a creature's animal companion name.

GetFormerMaster

Determines the player that was the master of a NPC.

GetGoingToBeAttackedBy

Determines the creature that is going to attack another creature in the current combat round.

GetHenchman

Determines the henchman of a PC.

GetIsPossessedFamiliar

Retrieves the controller status of a familiar.

GetLastAssociateCommand

Get the last command issued to a given associate.

GetLastHostileActor

Gets the last living, non plot creature that performed a hostile act against the object.

GetListenPatternNumber

Check if a conversation pattern has been activated in an OnConversation event.

GetLockedObject

Finds the closest locked object up to a maximum of 10 objects away.

GetMaster

Determine who controls a creature.

GetMatchedSubstring

Get a matched substring specified by a listen pattern.

GetMatchedSubstringsCount

Get the number of listen pattern substrings matched.

GetMaxHenchmen

Gets the maximum number of henchmen

GetWorkingForPlayer

Returns if the henchman is working for the player.

GiveChapterRewardItem

Gives a reward item to the player.

GivePersonalItem

Makes the henchman give his or her personal item to the player.

HasChapterRewardItem

Checks if player has the chapter reward item.

HasPersonalItem

Checks if the player has the henchman’s personal item.

IsBusy

Determines whether an associate is busy.

LevelUpHenchman

Levels up a creature using the default settings.

OpenInventory

Opens a player's inventory panel.

OpenNearestLock

Doesn’t work.

PC

debug function for displaying strings. Returns the first pc in the area

RemoveHenchman

Removes the henchmen from the employ of a PC.

RemoveSummonedAssociate

Removes an associate NPC from the service of a PC.

ResetHenchmenState

Henchman becomes available for other instructions by PC.

SetAssociateListenPatterns

Prepares an associate (henchman, summoned, familiar) to be commanded.

SetAssociateStartLocation

Sets an NPC associate's start location to it's current location.

SetAssociateState

Changes the behavior of an associate.

SetBeenHired

Sets whether a henchman has been hired before

SetDidDie

Stores if the henchman has just died

SetFormerMaster

Marks someone as an NPC henchman's former master PC.

SetIsBusy

Causes an associate to be considered busy.

SetListening

Sets whether an object should listen.

SetListenPattern

Sets an object to listen to a particular pattern.

SetMaxHenchmen

Sets the maximum number of henchmen

SetSummonEffect

Specifies the visual special effect and specific creature to be summoned based on the spell cast.

SetWorkingForPlayer

Specifies the PC name the henchman is working for.

SpawnHenchman

Creates the henchmen for each chapter of the original campaign of appropriate level for PC.

SpeakQuickChat

Sends a line of text overhead the henchman.

StripAllPersonalItemsFromEveryone

Removes henchmen 'hired' items for use in the original campaign.

SummonAnimalCompanion

SummonFamiliar

UnpossessFamiliar

Unpossesses a familiar from its controller.