Ability ApplyEffectOnObjectArray - Revision history

Sunjammer at 19:34, 3 August 2011

2011-08-03T19:34:50Z

Sunjammer: Updating links

2011-08-03T19:27:05Z

Updating links

BryanDerksen at 00:31, 25 February 2010

2010-02-25T00:31:35Z

BryanDerksen at 00:29, 25 February 2010

2010-02-25T00:29:59Z

BryanDerksen: Created page with '{{dafunction |name = Ability_ApplyEffectOnObjectArray |brief = Wrapper for ApplyEffectOnObject on an array of Objects |param1type = int |param1name = nDurationType |param1des...'

2010-02-25T00:28:59Z

Created page with '{{dafunction |name = Ability_ApplyEffectOnObjectArray |brief = Wrapper for ApplyEffectOnObject on an array of Objects |param1type = int |param1name = nDurationType |param1des...'

New page

{{dafunction
|name = Ability_ApplyEffectOnObjectArray
|brief = Wrapper for [[ApplyEffectOnObject]] on an array of Objects
|param1type = int
|param1name = nDurationType
|param1desc= can be [[EFFECT_DURATION_TYPE_PERMANENT]] [[EFFECT_DURATION_TYPE_INSTANTANEOUS]] or [[EFFECT_DURATION_TYPE_TEMPORARY]].
|param2type = effect
|param2name = eEffect
|param2desc= the effect to be applied
|param3type = object
|param3arra=true
|param3name = arTarget
|param3desc= the targets of the effect
|param4type = float
|param4name = fDuration
|param4desc= this value needs to be set only when nDurationType is EFFECT_DURATION_TYPE_TEMPORARY
|param4default=0.0f
|param5type =object
|param5name =oCreator
|param5desc= effect creator
|param5default=[[OBJECT_SELF]]
|param6type = int
|param6name = nAbilityId
|param6desc=The ability ID of the effect (Important for dispelling!!!)
|param6default=0
|param7type = int
|param7name = bSendAttackedEvent
|param7desc= Whether to send an attacked event as well.
|param7default=FALSE
|param8type = int
|param8name = bPreventStacking
|param8desc= Prevent Stacking?.
|param8default=TRUE
|param9type =int
|param9name =bExcludeCreator
|param9desc= {{undocumented}}
|param9default=FALSE
|returntype = void
|returndesc =
|sourcefile = ability_h
|sourcemodule = Core Resources
}}

@@ Line 14: / Line 14: @@
 |param4type    = float
 |param4name    = fDuration
-|param4desc    = this value needs to be set only when nDurationType is EFFECT_DURATION_TYPE_TEMPORARY
+|param4desc    = the duration in seconds (only required when nDurationType is [[EFFECT_DURATION_TYPE_*|EFFECT_DURATION_TYPE_TEMPORARY]])
 |param4default = 0.0
 |param5type    = object
@@ Line 22: / Line 22: @@
 |param6type    = int
 |param6name    = nAbilityId
-|param6desc    = The ability ID of the effect (Important for dispelling!!!)
+|param6desc    = The ability ID of the effect (important for dispelling)
 |param6default = 0
 |param7type    = int

@@ Line 1: / Line 1: @@
 {{dafunction
-|name = Ability_ApplyEffectOnObjectArray
+|name          = Ability_ApplyEffectOnObjectArray
-|brief = Wrapper for [[ApplyEffectOnObject]] on an array of Objects
+|brief         = Wrapper for [[ApplyEffectOnObject]] on an array of Objects
-|param1type = int
+|param1type    = int
-|param1name = nDurationType
+|param1name    = nDurationType
-|param1desc= can be [[EFFECT_DURATION_TYPE_PERMANENT]] [[EFFECT_DURATION_TYPE_INSTANT]] or [[EFFECT_DURATION_TYPE_TEMPORARY]].
+|param1desc    = [[EFFECT_DURATION_TYPE_*|EFFECT_DURATION_TYPE_PERMANENT]], [[EFFECT_DURATION_TYPE_*|EFFECT_DURATION_TYPE_INSTANT]] or [[EFFECT_DURATION_TYPE_*|EFFECT_DURATION_TYPE_TEMPORARY]]
-|param2type = effect
+|param2type    = effect
-|param2name = eEffect
+|param2name    = eEffect
-|param2desc= the effect to be applied
+|param2desc    = the effect to be applied
-|param3type = object
+|param3type    = object
-|param3arra=true
+|param3arra    = true
-|param3name = arTarget
+|param3name    = arTarget
-|param3desc= the targets of the effect
+|param3desc    = the targets of the effect
-|param4type = float
+|param4type    = float
-|param4name = fDuration
+|param4name    = fDuration
-|param4desc=  this value needs to be set only when nDurationType is EFFECT_DURATION_TYPE_TEMPORARY
+|param4desc    = this value needs to be set only when nDurationType is EFFECT_DURATION_TYPE_TEMPORARY
-|param4default=0.0f
+|param4default = 0.0
-|param5type =object
+|param5type    = object
-|param5name =oCreator
+|param5name    = oCreator
-|param5desc= effect creator
+|param5desc    = effect creator
-|param5default=[[OBJECT_SELF]]
+|param5default =[[OBJECT_SELF keyword|OBJECT_SELF]]
-|param6type = int
+|param6type    = int
-|param6name = nAbilityId
+|param6name    = nAbilityId
-|param6desc=The ability ID of the effect (Important for dispelling!!!)
+|param6desc    = The ability ID of the effect (Important for dispelling!!!)
-|param6default=0
+|param6default = 0
-|param7type = int
+|param7type    = int
-|param7name = bSendAttackedEvent
+|param7name    = bSendAttackedEvent
-|param7desc= Whether to send an attacked event as well.
+|param7desc    = Whether to send an attacked event as well.
-|param7default=FALSE
+|param7default = FALSE
-|param8type = int
+|param8type    = int
-|param8name = bPreventStacking
+|param8name    = bPreventStacking
-|param8desc= Prevent Stacking?.
+|param8desc    = Prevent Stacking?.
-|param8default=TRUE
+|param8default = TRUE
-|param9type =int
+|param9type    = int
-|param9name =bExcludeCreator
+|param9name    = bExcludeCreator
-|param9desc= {{undocumented}}
+|param9desc    = {{undocumented}}
-|param9default=FALSE
+|param9default = FALSE
-|returntype = void
+|returntype    = void
-|returndesc =
+|returndesc    =
-|sourcefile = ability_h
+|sourcefile    = ability_h
-|sourcemodule = Core Resources
+|sourcemodule  = Core Game Resources
 }}

@@ Line 51: / Line 51: @@
 <!-- This section contains examples transcluded from the snippet library. -->
-<!-- == See also == -->
+== See also ==
 <!-- This section contains links to articles, functions or constant groups. -->