Difference between revisions of "UT FireFollower"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) |
m (Adding Remarks section, adding missing parameter description) |
||
| Line 1: | Line 1: | ||
{{dafunction | {{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 = | |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 | |param2default = FALSE | ||
| − | |param3type = int | + | |param3type = int |
| − | |param3name = bRemoveEquipment | + | |param3name = bRemoveEquipment |
| − | |param3desc = | + | |param3desc = TRUE, to remove and return the creature's equipment to the party's inventory, or FALSE |
|param3default = TRUE | |param3default = TRUE | ||
| − | |returntype = void | + | |returntype = void |
| − | |returndesc = | + | |returndesc = |
| − | |sourcefile = utility_h | + | |sourcefile = utility_h |
| − | |sourcemodule = Core Resources | + | |sourcemodule = Core Game Resources |
}} | }} | ||
== Description == | == Description == | ||
<!-- 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. --> | ||
| + | Removes a follower from the active party, sending him back to the party pool. This function will do nothing for plot followers. | ||
| − | + | == Remarks == | |
| − | + | ||
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
| + | Plot followers are the creatures with tags defined by the [[GEN_FL_*]] constants. | ||
<!-- == 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. --> | ||
Latest revision as of 12:16, 26 October 2014
Removes a non-plot follower from the active party, sending him back to the party pool
- Parameters:
- oFollower
- The creature leaving the party
- bRemoveFromPool
- Remove or not from the party pool
- bRemoveEquipment
- TRUE, to remove and return the creature's equipment to the party's inventory, or FALSE
- Returns:
- Nothing.
- Source:
- Core Game Resources.utility_h
Description
Removes a follower from the active party, sending him back to the party pool. This function will do nothing for plot followers.
Remarks
Plot followers are the creatures with tags defined by the GEN_FL_* constants.
