GetEffects - Revision history

Sunjammer: Correcting category, correcting parameters

2012-03-10T18:40:09Z

Correcting category, correcting parameters

Sunjammer: Generated by Sunjammer's Dragon Age Script Paser

2009-07-31T22:37:17Z

Generated by Sunjammer's Dragon Age Script Paser

BryanDerksen: 1 revision: re-import with default parameter value parameters set

2009-07-31T22:14:50Z

1 revision: re-import with default parameter value parameters set

BryanDerksen: 1 revision: Importing auto-generated function articles

2009-07-29T15:50:18Z

1 revision: Importing auto-generated function articles

Sunjammer: Generated by Sunjammer's Dragon Age Script Paser

2009-07-29T01:40:43Z

Generated by Sunjammer's Dragon Age Script Paser

New page

{{Generated with errors}}
{{dafunction
|name=GetEffects
|brief=Returns the list of effects that are currently applied to an object.
|param1type=object
|param1name=oObject
|param1desc=The object from which we try to get the effects list
|param2type=int
|param2name=nEffectType
|param2desc=(optional) only return an array of a specified EffectType. Default setting returns all applied effects
|param3type=int
|param3name=nAbilityId
|param3desc=(optional) filter the returned array to include only effects with a matching ability id (0 means no filter)
|param4type=object
|param4name=oCreator
|param4desc=
|param5type=int
|param5name=nDurationType
|param5desc=(optional) filter the array by DurationType (EFFECT_DURATION_TYPE_INVALID means no filter)
|param6type=int
|param6name=nEffectId
|param6desc=(optional) filter the array by EffectId (-1 means no filter)
|returntype=effect[]
|returndesc=
|sourcefile=script.ldf
|sourcemodule=
}}

== 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.










[[Category: Effect access functions]]

@@ Line 1: / Line 1: @@
 {{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 EffectType. Default setting returns all applied effects
+|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 (0 means no filter)
+|param3desc    = (optional) filter the returned array to include only effects with a matching ability id ([[ABILITY_*|ABILITY_INVALID]] means no filter)
-|param3default=0
+|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 DurationType (EFFECT_DURATION_TYPE_INVALID means no filter)
+|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 EffectId (-1 means no filter)
+|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
 }}
 == Description ==
 <!-- 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 == -->
 <!-- This section contains additional comments, observations and known issues. -->
 <!-- == Examples == -->
 <!-- This section contains examples transcluded from the snippet library. -->
 <!-- == See also == -->
 <!-- This section contains links to articles, functions or constant groups. -->
-[[Category: Effect access functions]]
+[[Category:Effect functions]]

← Older revision	Revision as of 22:14, 31 July 2009
(No difference)

← Older revision	Revision as of 15:50, 29 July 2009
(No difference)