Difference between revisions of "RemoveEffectsByParameters"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) (looks okay, removing tag) |
m (Updating links) |
||
| Line 1: | Line 1: | ||
{{dafunction | {{dafunction | ||
| − | |name=RemoveEffectsByParameters | + | |name = RemoveEffectsByParameters |
| − | |brief=Remove effects based on certain parameters | + | |brief = Remove effects based on certain parameters |
| − | |param1type=object | + | |param1type = object |
| − | |param1name=oTarget | + | |param1name = oTarget |
| − | |param1desc=The object to remove the effect from | + | |param1desc = The object to remove the effect from |
| − | |param1default= | + | |param1default = |
| − | |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_*|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_*|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 keyword|OBJECT_INVALID]] will remove effects created by anything) |
| − | |param4default=OBJECT_INVALID | + | |param4default = OBJECT_INVALID |
| − | |returntype=void | + | |returntype = void |
| − | |returndesc= | + | |returndesc = |
| − | |sourcefile=script.ldf | + | |sourcefile = script.ldf |
| − | |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 == --> | ||
Revision as of 20:15, 3 August 2011
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.
