Difference between revisions of "SetFollowerState"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (1 revision: Importing auto-generated function articles)
m (Updating link)
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Generated}}
 
 
{{dafunction
 
{{dafunction
 
|name=SetFollowerState
 
|name=SetFollowerState
Line 18: Line 17:
 
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
 
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
 
Follower State can be:
 
Follower State can be:
FOLLOWER_STATE_ACTIVE - Add follower to party pool + active party
+
*FOLLOWER_STATE_ACTIVE - Add follower to party pool + active party
FOLLOWER_STATE_AVAILABLE - Add follower to party pool and remove from active party
+
*FOLLOWER_STATE_AVAILABLE - Add follower to party pool and remove from active party
FOLLOWER_STATE_INVALID - Remove follower from party pool and active party
+
*FOLLOWER_STATE_INVALID - Remove follower from party pool and active party
FOLLOWER_STATE_UNAVAILABLE - Remove follower from active party and do not allow adding it to active party again
+
*FOLLOWER_STATE_UNAVAILABLE - Remove follower from active party and do not allow adding it to active party again
FOLLOWER_STATE_SUSPENDED - Remove follower from active party and store it for putting it back later into the party
+
*FOLLOWER_STATE_SUSPENDED - Remove follower from active party and store it for putting it back later into the party
 +
*FOLLOWER_STATE_LOCKED_ACTIVE - Add follower to active party and lock him active in the party picker.
  
 
<!-- == Remarks == -->
 
<!-- == Remarks == -->
Line 30: Line 30:
 
<!-- This section contains examples transcluded from the snippet library. -->
 
<!-- This section contains examples transcluded from the snippet library. -->
  
<!-- == See also == -->
+
== See also ==
 
<!-- This section contains links to articles, functions or constant groups. -->
 
<!-- This section contains links to articles, functions or constant groups. -->
 +
See [[FOLLOWER STATE_*]] for more details on the constants you can use.
  
 
[[Category: Party and group control]]
 
[[Category: Party and group control]]

Latest revision as of 20:04, 3 August 2011

Set the state of the follower.

void SetFollowerState(
object oCreature,
int nState
);
Parameters:
oCreature
Party follower
nState
the state
Returns:

Nothing.

Source:

script.ldf

Description

Follower State can be:

  • FOLLOWER_STATE_ACTIVE - Add follower to party pool + active party
  • FOLLOWER_STATE_AVAILABLE - Add follower to party pool and remove from active party
  • FOLLOWER_STATE_INVALID - Remove follower from party pool and active party
  • FOLLOWER_STATE_UNAVAILABLE - Remove follower from active party and do not allow adding it to active party again
  • FOLLOWER_STATE_SUSPENDED - Remove follower from active party and store it for putting it back later into the party
  • FOLLOWER_STATE_LOCKED_ACTIVE - Add follower to active party and lock him active in the party picker.


See also

See FOLLOWER STATE_* for more details on the constants you can use.