GetEffects
From Dragon Age Toolset Wiki
Returns the list of effects that are currently applied to an object.
effect[] GetEffects(
object oObject,
int nEffectType = EFFECT_TYPE_INVALID,
int nAbilityId = ABILITY_INVALID,
object oCreator = OBJECT_INVALID,
int nDurationType = EFFECT_DURATION_TYPE_INVALID,
int nEffectId = -1
);
object oObject,
int nEffectType = EFFECT_TYPE_INVALID,
int nAbilityId = ABILITY_INVALID,
object oCreator = OBJECT_INVALID,
int nDurationType = EFFECT_DURATION_TYPE_INVALID,
int nEffectId = -1
);
- Parameters:
- oObject
- The object from which we try to get the effects list
- nEffectType
- (optional) only return an array of a specified effect type (EFFECT_TYPE_INVALID means no filter)
- nAbilityId
- (optional) filter the returned array to include only effects with a matching ability id (ABILITY_INVALID means no filter)
- oCreator
- (optional) filter the returned array to include only effects created by a specific object (OBJECT_INVALID means no filter)
- nDurationType
- (optional) filter the array by duration type (EFFECT_DURATION_TYPE_INVALID means no filter)
- nEffectId
- (optional) filter the array by effect ID (-1 means no filter)
- Returns:
- Returns the all effects that are currently applied to an object taking account of any specified filters.
- Source:
- script.ldf
Description
Returns the list of effects that are currently applied to an object. This includes both temporary and permanent effects. The order of the events inside the list is meaningless.
