UT FireFollower - Revision history

Sunjammer: Adding Remarks section, adding missing parameter description

2014-10-26T11:16:34Z

Adding Remarks section, adding missing parameter description

BryanDerksen: Category:Party and group control

2010-02-10T21:07:13Z

Category:Party and group control

BryanDerksen at 20:59, 10 February 2010

2010-02-10T20:59:36Z

BryanDerksen: Created page with '{{dafunction |name = UT_FireFollower |brief = Removes a non-plot follower from the active party, sending him back to the party pool |param1type = object |param1name = oFollower |...'

2010-02-10T18:00:46Z

Created page with '{{dafunction |name = UT_FireFollower |brief = Removes a non-plot follower from the active party, sending him back to the party pool |param1type = object |param1name = oFollower |...'

New page

{{dafunction
|name = UT_FireFollower
|brief = Removes a non-plot follower from the active party, sending him back to the party pool
|param1type = object
|param1name = oFollower
|param1desc = The creature leaving the party
|param1default =
|param2type = int
|param2name = bRemoveFromPool
|param2desc = Remove or not from the party pool
|param2default = FALSE
|param3type = int
|param3name = bRemoveEquipment
|param3desc = {{undocumented}}
|param3default = TRUE
|returntype = void
|returndesc =
|sourcefile = utility_h
|sourcemodule = Core Resources
}}

== Description ==


Removes a follower from the active party, sending him back to the party pool. This function will do nothing for plot followers.







== See also ==


[[UT_HireFollower]]

← Older revision		Revision as of 21:07, 10 February 2010
Line 34:		Line 34:

	[[UT_HireFollower]]		[[UT_HireFollower]]
		+	[[Category:Party and group control]]

@@ Line 1: / Line 1: @@
 {{dafunction
-|name = UT_FireFollower
+|name          = UT_FireFollower
-|brief = Removes a non-plot follower from the active party, sending him back to the party pool
+|brief         = Removes a non-plot follower from the active party, sending him back to the party pool
-|param1type = object
+|param1type    = object
-|param1name = oFollower
+|param1name    = oFollower
-|param1desc = The creature leaving the party
+|param1desc    = The creature leaving the party
 |param1default =
-|param2type = int
+|param2type    = int
-|param2name = bRemoveFromPool
+|param2name    = bRemoveFromPool
-|param2desc = Remove or not from the party pool
+|param2desc    = Remove or not from the party pool
 |param2default = FALSE
-|param3type = int
+|param3type    = int
-|param3name = bRemoveEquipment
+|param3name    = bRemoveEquipment
-|param3desc = {{undocumented}}
+|param3desc    = TRUE, to remove and return the creature's equipment to the party's inventory, or FALSE
 |param3default = TRUE
-|returntype = void
+|returntype    = void
-|returndesc =
+|returndesc    =
-|sourcefile = utility_h
+|sourcefile    = utility_h
-|sourcemodule = Core Resources
+|sourcemodule  = Core Game Resources
 }}
 == Description ==
 <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
-Removes a follower from the active party, sending him back to the party pool. 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.
+== Remarks ==
-<!-- == Remarks == -->
 <!-- This section contains additional comments, observations and known issues. -->
 <!-- == Examples == -->
 <!-- This section contains examples transcluded from the snippet library. -->
 == See also ==
 <!-- This section contains links to articles, functions or constant groups. -->