Difference between revisions of "RemoveEffectsByParameters"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (1 revision: re-import with default parameter value parameters set)
(looks okay, removing tag)
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Generated}}
 
 
{{dafunction
 
{{dafunction
 
|name=RemoveEffectsByParameters
 
|name=RemoveEffectsByParameters
Line 9: Line 8:
 
|param2type=int
 
|param2type=int
 
|param2name=nType
 
|param2name=nType
|param2desc=Only remove effects of this type (setting EFFECT_TYPE_INVALID will remove all types of effects)
+
|param2desc=Only remove effects of this type (setting [[EFFECT_TYPE_INVALID]] will remove all types of effects)
 
|param2default=EFFECT_TYPE_INVALID
 
|param2default=EFFECT_TYPE_INVALID
 
|param3type=int
 
|param3type=int
 
|param3name=nAbilityId
 
|param3name=nAbilityId
|param3desc=Only remove effects of with this ability id (setting ABILITY_INVALID will remove effects due to any ability)
+
|param3desc=Only remove effects of with this ability id (setting [[ABILITY_INVALID]] will remove effects due to any ability)
 
|param3default=ABILITY_INVALID
 
|param3default=ABILITY_INVALID
 
|param4type=object
 
|param4type=object
 
|param4name=oCreator
 
|param4name=oCreator
|param4desc=Only remove effects created by this object (setting OBJECT_INVALID will remove effects created by anything)
+
|param4desc=Only remove effects created by this object (setting [[OBJECT_INVALID]] will remove effects created by anything)
 
|param4default=OBJECT_INVALID
 
|param4default=OBJECT_INVALID
 
|returntype=void
 
|returntype=void

Revision as of 18:53, 3 March 2010

Remove effects based on certain parameters

void RemoveEffectsByParameters(
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