Difference between revisions of "RemoveEffectsByParameters"
From Dragon Age Toolset Wiki
(Generated by Sunjammer's Dragon Age Script Paser) |
BryanDerksen (Talk | contribs) m (1 revision: re-import with default parameter value parameters set) |
(No difference)
| |
Revision as of 23:28, 31 July 2009
This page was generated by Sunjammer's Dragon Age Script Parser.
The parser extracted and matched all the information required to the best of its ability however the parser relies on the source file, and especially a function's comments, to be correctly formatted. If the source file was not correctly formatted the information presented may be incomplete.
This page should be reviewed by a knowledgeable scripter as it may require updating. If an issue with the source file is identified it should be reported to BioWare.
Please remove the {{Generated}} tag once the page has been confirmed or corrected.
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
