Difference between revisions of "UT HireFollower"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (Adding link and formatting)
Line 1: Line 1:
 
{{dafunction
 
{{dafunction
|name = UT_HireFollower
+
|name         = UT_HireFollower
|brief = Hire non-plot follower into the active party for oPC
+
|brief         = Hire non-plot follower into the active party for oPC
|param1type = object
+
|param1type   = object
|param1name = oFollower
+
|param1name   = oFollower
|param1desc = The creature joining the party
+
|param1desc   = The creature joining the party
 
|param1default =
 
|param1default =
|param2type = int
+
|param2type   = int
|param2name = bPreventLevelup
+
|param2name   = bPreventLevelup
|param2desc = whether or not to prevent the follower from levelling up
+
|param2desc   = whether or not to prevent the follower from levelling up
 
|param2default = FALSE
 
|param2default = FALSE
|returntype = void
+
|returntype   = void
|returndesc =  
+
|returndesc   =  
|sourcefile = utility_h
+
|sourcefile   = utility_h
|sourcemodule = Core Resources
+
|sourcemodule = Core Game Resources
 
}}
 
}}
  
Line 19: Line 19:
 
<!-- 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. -->
  
Hire follower into the active party for oPC. This function will do nothing for plot followers, which are creatures with one of the tags defined by GEN_FL_ALISTAIR, GEN_FL_DOG, GEN_FL_MORRIGAN, GEN_FL_WYNNE, GEN_FL_SHALE, GEN_FL_STEN, GEN_FL_ZEVRAN, GEN_FL_OGHREN, GEN_FL_LELIANA or GEN_FL_LOGHAIN.
+
Hire follower into the active party for oPC. This function will do nothing for plot followers, which are creatures with one of the tags defined by one of the following [[GEN_FL_*]] constants:
 +
* GEN_FL_ALISTAIR
 +
* GEN_FL_DOG
 +
* GEN_FL_MORRIGAN
 +
* GEN_FL_WYNNE
 +
* GEN_FL_SHALE
 +
* GEN_FL_STEN
 +
* GEN_FL_ZEVRAN
 +
* GEN_FL_OGHREN
 +
* GEN_FL_LELIANA
 +
* GEN_FL_LOGHAIN
  
 
<!-- == Remarks == -->
 
<!-- == Remarks == -->
 
<!-- This section contains additional comments, observations and known issues. -->
 
<!-- This section contains additional comments, observations and known issues. -->
 
 
<!-- == Examples == -->
 
<!-- == Examples == -->
 
<!-- 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. -->
 
 
[[UT_FireFollower]]
 
[[UT_FireFollower]]
 
[[Category:Party and group control]]
 
[[Category:Party and group control]]

Revision as of 02:36, 11 February 2012

Hire non-plot follower into the active party for oPC

void UT_HireFollower(
object oFollower,
int bPreventLevelup = FALSE
);
Parameters:
oFollower
The creature joining the party
bPreventLevelup
whether or not to prevent the follower from levelling up
Returns:

Nothing.

Source:

Core Game Resources.utility_h

Description

Hire follower into the active party for oPC. This function will do nothing for plot followers, which are creatures with one of the tags defined by one of the following GEN_FL_* constants:

  • GEN_FL_ALISTAIR
  • GEN_FL_DOG
  • GEN_FL_MORRIGAN
  • GEN_FL_WYNNE
  • GEN_FL_SHALE
  • GEN_FL_STEN
  • GEN_FL_ZEVRAN
  • GEN_FL_OGHREN
  • GEN_FL_LELIANA
  • GEN_FL_LOGHAIN

See also

UT_FireFollower