Difference between revisions of "RemoveEffectsByParameters"
From Dragon Age Toolset Wiki
m (Updating links) |
m (Correcting category) |
||
| Line 23: | Line 23: | ||
|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 a group of effects that have the specified values from the object it's applied to. | Removes a group of effects that have the specified values from the object it's applied to. | ||
| − | |||
<!-- == 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:00, 10 March 2012
Remove effects based on certain parameters
void RemoveEffectsByParameters(
object oTarget,
int nType = EFFECT_TYPE_INVALID,
int nAbilityId = ABILITY_INVALID,
object oCreator = OBJECT_INVALID
);
object oTarget,
int nType = EFFECT_TYPE_INVALID,
int nAbilityId = ABILITY_INVALID,
object oCreator = OBJECT_INVALID
);
- Parameters:
- oTarget
- The object to remove the effect from
- nType
- Only remove effects of this type (setting EFFECT_TYPE_INVALID will remove all types of effects)
- nAbilityId
- Only remove effects of with this ability id (setting ABILITY_INVALID will remove effects due to any ability)
- oCreator
- Only remove effects created by this object (setting OBJECT_INVALID will remove effects created by anything)
- Returns:
- Nothing.
- Source:
- script.ldf
Description
Removes a group of effects that have the specified values from the object it's applied to.
