Difference between revisions of "GetEffects"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (1 revision: re-import with default parameter value parameters set) |
m (Correcting category, correcting parameters) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
| − | |name=GetEffects | + | |name = GetEffects |
| − | |brief=Returns the list of effects that are currently applied to an object. | + | |brief = Returns the list of effects that are currently applied to an object. |
| − | |param1type=object | + | |param1type = object |
| − | |param1name=oObject | + | |param1name = oObject |
| − | |param1desc=The object from which we try to get the effects list | + | |param1desc = The object from which we try to get the effects list |
| − | |param1default= | + | |param1default = |
| − | |param2type=int | + | |param2type = int |
| − | |param2name=nEffectType | + | |param2name = nEffectType |
| − | |param2desc=(optional) only return an array of a specified | + | |param2desc = (optional) only return an array of a specified effect type ([[EFFECT_TYPE_*|EFFECT_TYPE_INVALID]] means no filter) |
| − | |param2default=EFFECT_TYPE_INVALID | + | |param2default = EFFECT_TYPE_INVALID |
| − | |param3type=int | + | |param3type = int |
| − | |param3name=nAbilityId | + | |param3name = nAbilityId |
| − | |param3desc=(optional) filter the returned array to include only effects with a matching ability id ( | + | |param3desc = (optional) filter the returned array to include only effects with a matching ability id ([[ABILITY_*|ABILITY_INVALID]] means no filter) |
| − | |param3default= | + | |param3default = ABILITY_INVALID |
| − | |param4type=object | + | |param4type = object |
| − | |param4name=oCreator | + | |param4name = oCreator |
| − | |param4desc= | + | |param4desc = (optional) filter the returned array to include only effects created by a specific object ([[OBJECT_INVALID keyword|OBJECT_INVALID]] means no filter) |
| − | |param4default=OBJECT_INVALID | + | |param4default = OBJECT_INVALID |
| − | |param5type=int | + | |param5type = int |
| − | |param5name=nDurationType | + | |param5name = nDurationType |
| − | |param5desc=(optional) filter the array by | + | |param5desc = (optional) filter the array by duration type ([[EFFECT_DURATION_TYPE_*|EFFECT_DURATION_TYPE_INVALID]] means no filter) |
| − | |param5default=EFFECT_DURATION_TYPE_INVALID | + | |param5default = EFFECT_DURATION_TYPE_INVALID |
| − | |param6type=int | + | |param6type = int |
| − | |param6name=nEffectId | + | |param6name = nEffectId |
| − | |param6desc=(optional) filter the array by | + | |param6desc = (optional) filter the array by effect ID (-1 means no filter) |
| − | |param6default=-1 | + | |param6default = -1 |
| − | |returntype=effect[] | + | |returntype = effect |
| − | |returndesc= | + | |returnarra = [] |
| − | |sourcefile=script.ldf | + | |returndesc = Returns the all effects that are currently applied to an object taking account of any specified filters. |
| − | |sourcemodule= | + | |sourcefile = script.ldf |
| + | |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. --> | ||
| − | Returns the list of effects that are currently applied to an object. This includes both | + | 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. |
| − | temporary and permanent effects. The order of the events inside the list is meaningless. | + | |
| − | + | ||
<!-- == Remarks == --> | <!-- == Remarks == --> | ||
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
| − | |||
<!-- == Examples == --> | <!-- == Examples == --> | ||
<!-- This section contains examples transcluded from the snippet library. --> | <!-- This section contains examples transcluded from the snippet library. --> | ||
| − | |||
<!-- == See also == --> | <!-- == See also == --> | ||
<!-- This section contains links to articles, functions or constant groups. --> | <!-- This section contains links to articles, functions or constant groups. --> | ||
| − | [[Category: Effect | + | [[Category:Effect functions]] |
Latest revision as of 19:40, 10 March 2012
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.
