ClearAssociateActions(object, int)
Clear the actions of one of each type of the PC's associates
void ClearAssociateActions( object oPC, int bClearCombat = FALSE );
Parameters
oPC
Player Character
bClearCombat
Stop combat along with all other actions (Default: FALSE)
Description
Clear all the actions of the action queue of one of each type of the PC's associates. Use this to cancel any previous instructions to single associates, before assigning new orders.
Associate types include the henchman, dominated, familiar, summoned and animal companion creatures.
Note that unless nClearCombatState is set to TRUE, any current fighting involving the associates will continue.
Remarks
Include library for party-wide functions.
NOTE: this library is included in "x0_i0_common" already.
Do NOT dual-include both files or you will get errors!
Known Bugs
This function does not loop through multiple associates of any particular type. For example, if SetMaxHenchmen has been used to increase the number of henchpeople, ClearAssociateActions performs a search (GetAssociate) for only one henchperson.
Requirements
#include "X0_I0_PARTYWIDE"
Version
1.61
See Also
categories: | Action on Object Functions | Combat Actions Functions | Henchmen/Familiars/Summoned Functions |
author: Peter Busby