Difference between revisions of "RemoveAllEffects"
From Dragon Age Toolset Wiki
(Generated by Sunjammer's Dragon Age Script Paser) |
m (Correcting category) |
||
(One intermediate revision by one other user not shown) | |||
Line 1: | Line 1: | ||
− | |||
{{dafunction | {{dafunction | ||
|name=RemoveAllEffects | |name=RemoveAllEffects | ||
Line 9: | Line 8: | ||
|param2type=int | |param2type=int | ||
|param2name=bIgnoreInjuries | |param2name=bIgnoreInjuries | ||
− | |param2desc=Don't remove effects that are due to injuries (that are within a certain ability id range) | + | |param2desc=Don't remove effects that are due to injuries (that are within a certain ability id range{{undocumented}}) |
|param2default=TRUE | |param2default=TRUE | ||
|param3type=int | |param3type=int | ||
Line 20: | 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 | + | [[Category:Effect functions]] |
Latest revision as of 19:01, 10 March 2012
Remove all effects on an object with certain limitations
- 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.