Difference between revisions of "RemoveAllEffects"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(remove tag, add {{undocumented}} for the ability ID range)
m (Correcting category)
 
Line 19: Line 19:
 
|sourcemodule=
 
|sourcemodule=
 
}}
 
}}
 
 
== 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 all the effects on an object. You can exclude effects due to injuries and effects that ignore death.
 
Removes all the effects on an object. You can exclude effects due to injuries and effects that ignore death.
 
 
<!-- == 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. -->
  
[[Category: Effect access functions]]
+
[[Category:Effect functions]]

Latest revision as of 19:01, 10 March 2012

Remove all effects on an object with certain limitations

void RemoveAllEffects(
object oTarget,
int bIgnoreInjuries = TRUE,
int bDeath = FALSE
);
Parameters:
oTarget
The object to remove the effect from
bIgnoreInjuries
Don't remove effects that are due to injuries (that are within a certain ability id range[Undocumented])
bDeath
Don't remove effects that ignore death (use this when removing effects on a creature due to it dying)
Returns:

Nothing.

Source:

script.ldf

Description

Removes all the effects on an object. You can exclude effects due to injuries and effects that ignore death.