Xordac: 1 revision imported

2017-10-23T23:23:20Z

1 revision imported

New page

=Henchmen/Familiars/Summoned Function Category=

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

<br /><br />

====Functions====

{| border="1" cellpadding="5"
! Name
! Brief Description
|-
|
[[ActionForceFollowObject | ActionForceFollowObject ]]
| Forces an NPC to follow an object.
|-
|
[[ActionUseSkill | ActionUseSkill ]]
| Causes a creature to attempt to use a skill on another object.
|-
|
[[AddHenchman | AddHenchman ]]
| Adds a henchman NPC to a PC.
|-
|
[[CheckIsUnlocked | CheckIsUnlocked ]]
| Plays voice chat messages that indicates the locked status of a door or placeable.
|-
|
[[ClearAssociateActions | ClearAssociateActions ]]
| Clear the actions of one of each type of the PC's associates
|-
|
[[CopyLocals | CopyLocals ]]
| Copies locals from earlier level henchmen to newer henchman
|-
|
[[CreateBalor | CreateBalor ]]
| Summons a Balor to fight for the caster
|-
|
[[DestroyAllPersonalItems | DestroyAllPersonalItems ]]
| Destroys all henchman items.
|-
|
[[DestroyChapterQuestItem | DestroyChapterQuestItem ]]
| Destroys the chapter specific quest item given to oPC by the henchman.
|-
|
[[DestroyChapterRewardItem | DestroyChapterRewardItem ]]
| Destroys the chapter specific reward item given to oPC by the henchman.
|-
|
[[DoFollowMaster | DoFollowMaster ]]
| Make the henchman approach its master if it is too far away, depending on the distance it has been asked to keep
|-
|
[[DoLevelUp | DoLevelUp ]]
| Levels up an NPC to appropriate PC henchman level.
|-
|
[[EffectSwarm | EffectSwarm ]]
| Returns a Swarm effect.
|-
|
[[EquipAppropriateWeapons | EquipAppropriateWeapons ]]
| Cause a creature to ready an appropriate weapon.
|-
|
[[GetAnimalCompanionCreatureType | GetAnimalCompanionCreatureType ]]
| Get a creature's familiar creature type.
|-
|
[[GetAnimalCompanionName | GetAnimalCompanionName ]]
| Gets a creature's familiar name.
|-
|
[[GetAssociate | GetAssociate ]]
| Returns an object's associate.
|-
|
[[GetAssociateCRMax | GetAssociateCRMax ]]
|
|-
|
[[GetAssociateHealMaster | GetAssociateHealMaster ]]
|
|-
|
[[GetAssociateStartLocation | GetAssociateStartLocation ]]
| Gets the start location of an NPC associate.
|-
|
[[GetAssociateState | GetAssociateState ]]
|
|-
|
[[GetAssociateType | GetAssociateType ]]
| Returns the associate type of the specified creature
|-
|
[[GetBeenHired | GetBeenHired ]]
| Checks if a henchman has been hired.
|-
|
[[GetBehind | GetBehind ]]
| Causes the caller to move behind the player who is considered their Master.
|-
|
[[GetCanLevelUp | GetCanLevelUp ]]
| Determines if an NPC henchman should level up.
|-
|
[[GetCreatureStartingPackage | GetCreatureStartingPackage ]]
| Returns the default level up package
|-
|
[[GetDidDie | GetDidDie ]]
| TRUE if the player has died.
|-
|
[[GetFactionMostDamagedMember | GetFactionMostDamagedMember ]]
| Get the member of oFactionMember's faction that has taken the most hit points of damage.
|-
|
[[GetFamiliarCreatureType | GetFamiliarCreatureType ]]
| Gets the PC's animal companion creature type.
|-
|
[[GetFamiliarName | GetFamiliarName ]]
| Get a creature's animal companion name.
|-
|
[[GetFormerMaster | GetFormerMaster ]]
| Determines the player that was the master of a NPC.
|-
|
[[GetGoingToBeAttackedBy | GetGoingToBeAttackedBy ]]
| Determines the creature that is going to attack another creature in the current combat round.
|-
|
[[GetHenchman | GetHenchman ]]
| Determines the henchman of a PC.
|-
|
[[GetIsPossessedFamiliar | GetIsPossessedFamiliar ]]
| Retrieves the controller status of a familiar.
|-
|
[[GetLastAssociateCommand | GetLastAssociateCommand ]]
| Get the last command issued to a given associate.
|-
|
[[GetLastHostileActor | GetLastHostileActor ]]
| Gets the last living, non plot creature that performed a hostile act against the object.
|-
|
[[GetListenPatternNumber | GetListenPatternNumber ]]
| Check if a conversation pattern has been activated in an OnConversation event.
|-
|
[[GetLockedObject | GetLockedObject ]]
| Finds the closest locked object up to a maximum of 10 objects away.
|-
|
[[GetMaster | GetMaster ]]
| Determine who controls a creature.
|-
|
[[GetMatchedSubstring | GetMatchedSubstring ]]
| Get a matched substring specified by a listen pattern.
|-
|
[[GetMatchedSubstringsCount | GetMatchedSubstringsCount ]]
| Get the number of listen pattern substrings matched.
|-
|
[[GetMaxHenchmen | GetMaxHenchmen ]]
| Gets the maximum number of henchmen
|-
|
[[GetWorkingForPlayer | GetWorkingForPlayer ]]
| Returns if the henchman is working for the player.
|-
|
[[GiveChapterRewardItem | GiveChapterRewardItem ]]
| Gives a reward item to the player.
|-
|
[[GivePersonalItem | GivePersonalItem ]]
| Makes the henchman give his or her personal item to the player.
|-
|
[[HasChapterRewardItem | HasChapterRewardItem ]]
| Checks if player has the chapter reward item.
|-
|
[[HasPersonalItem | HasPersonalItem ]]
| Checks if the player has the henchmanâs personal item.
|-
|
[[IsBusy | IsBusy ]]
| Determines whether an associate is busy.
|-
|
[[LevelUpHenchman | LevelUpHenchman ]]
| Levels up a creature using the default settings.
|-
|
[[OpenInventory | OpenInventory ]]
| Opens a player's inventory panel.
|-
|
[[OpenNearestLock | OpenNearestLock ]]
| Doesnât work.
|-
|
[[PC | PC ]]
| debug function for displaying strings. Returns the first pc in the area
|-
|
[[RemoveHenchman | RemoveHenchman ]]
| Removes the henchmen from the employ of a PC.
|-
|
[[RemoveSummonedAssociate | RemoveSummonedAssociate ]]
| Removes an associate NPC from the service of a PC.
|-
|
[[ResetHenchmenState | ResetHenchmenState ]]
| Henchman becomes available for other instructions by PC.
|-
|
[[SetAssociateListenPatterns | SetAssociateListenPatterns ]]
| Prepares an associate (henchman, summoned, familiar) to be commanded.
|-
|
[[SetAssociateStartLocation | SetAssociateStartLocation ]]
| Sets an NPC associate's start location to it's current location.
|-
|
[[SetAssociateState | SetAssociateState ]]
| Changes the behavior of an associate.
|-
|
[[SetBeenHired | SetBeenHired ]]
| Sets whether a henchman has been hired before
|-
|
[[SetDidDie | SetDidDie ]]
| Stores if the henchman has just died
|-
|
[[SetFormerMaster | SetFormerMaster ]]
| Marks someone as an NPC henchman's former master PC.
|-
|
[[SetIsBusy | SetIsBusy ]]
| Causes an associate to be considered busy.
|-
|
[[SetListening | SetListening ]]
| Sets whether an object should listen.
|-
|
[[SetListenPattern | SetListenPattern ]]
| Sets an object to listen to a particular pattern.
|-
|
[[SetMaxHenchmen | SetMaxHenchmen ]]
| Sets the maximum number of henchmen
|-
|
[[SetSummonEffect | SetSummonEffect ]]
| Specifies the visual special effect and specific creature to be summoned based on the spell cast.
|-
|
[[SetWorkingForPlayer | SetWorkingForPlayer ]]
| Specifies the PC name the henchman is working for.
|-
|
[[SpawnHenchman | SpawnHenchman ]]
| Creates the henchmen for each chapter of the original campaign of appropriate level for PC.
|-
|
[[SpeakQuickChat | SpeakQuickChat ]]
| Sends a line of text overhead the henchman.
|-
|
[[StripAllPersonalItemsFromEveryone | StripAllPersonalItemsFromEveryone ]]
| Removes henchmen 'hired' items for use in the original campaign.
|-
|
[[SummonAnimalCompanion | SummonAnimalCompanion ]]
|
|-
|
[[SummonFamiliar | SummonFamiliar ]]
|
|-
|
[[UnpossessFamiliar | UnpossessFamiliar ]]
| Unpossesses a familiar from its controller.
|}

----
[[Category:Functions]]
[[Category:Function_Categories]]

Category:Henchmen Familiars Summoned Functions - Revision history

Xordac: 1 revision imported