GetEffects

From Dragon Age Toolset Wiki
Revision as of 02:40, 29 July 2009 by Sunjammer (Talk | contribs) (Generated by Sunjammer's Dragon Age Script Paser)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This page was generated by Sunjammer's Dragon Age Script Parser.

The parser was unable to extract and/or match all the information required and has flagged this page as containing one or more errors. The source file was not formatted correctly and the information presented is incomplete or incorrect.

This page must be reviewed by a knowledgeable scripter as it will need to be updated. Once identified, the issue in the source file should be reported to BioWare.

Please remove the {{Generated with errors}} tag once the page has been corrected.

Returns the list of effects that are currently applied to an object.

[[effect[] keyword|effect[]]] GetEffects(
object oObject,
int nEffectType,
int nAbilityId,
object oCreator,
int nDurationType,
int nEffectId
);
Parameters:
oObject
The object from which we try to get the effects list
nEffectType
(optional) only return an array of a specified EffectType. Default setting returns all applied effects
nAbilityId
(optional) filter the returned array to include only effects with a matching ability id (0 means no filter)
oCreator
[Undocumented]
nDurationType
(optional) filter the array by DurationType (EFFECT_DURATION_TYPE_INVALID means no filter)
nEffectId
(optional) filter the array by EffectId (-1 means no filter)
Returns:

[Undocumented]

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.