Difference between revisions of "Ability ApplyRandomDurationEffectOnObjectArray"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(Created page with '{{dafunction |name = Ability_ApplyRandomDurationEffectOnObjectArray |brief = Wrapper for ApplyEffectOnObject on an array of Objects |param1type = int |param1name = nDurationT...')
 
m (Updating link)
Line 1: Line 1:
 
{{dafunction
 
{{dafunction
|name = Ability_ApplyRandomDurationEffectOnObjectArray
+
|name           = Ability_ApplyRandomDurationEffectOnObjectArray
|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= will only accept [[EFFECT_DURATION_TYPE_TEMPORARY]].
+
|param1desc     = will only accept [[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 = fDurationMin
+
|param4name     = fDurationMin
|param4desc= minimum duration of the effect
+
|param4desc     = minimum duration of the effect
|param4default=0.0f
+
|param4default = 0.0
|param5type = float
+
|param5type     = float
|param5name = fDurationMax
+
|param5name     = fDurationMax
|param5desc= maximum duration of the effect
+
|param5desc     = maximum duration of the effect
|param5default=0.0f
+
|param5default = 0.0
|param6type =object  
+
|param6type     = object  
|param6name =oCreator
+
|param6name     = oCreator
|param6desc= effect creator
+
|param6desc     = effect creator
|param6default=[[OBJECT_SELF]]
+
|param6default = [[OBJECT_SELF keyword]]
|param7type = int
+
|param7type     = int
|param7name = nAbilityId  
+
|param7name     = nAbilityId  
|param7desc=The ability ID of the effect (Important for dispelling!!!)
+
|param7desc     = The ability ID of the effect (Important for dispelling!!!)
|param7default=0
+
|param7default = 0
|param8type = int
+
|param8type     = int
|param8name = bSendAttackedEvent
+
|param8name     = bSendAttackedEvent
|param8desc= Whether to send an attacked event as well.
+
|param8desc     = Whether to send an attacked event as well.
|param8default=FALSE
+
|param8default = FALSE
|param9type = int
+
|param9type     = int
|param9name = bPreventStacking
+
|param9name     = bPreventStacking
|param9desc= Prevent Stacking?.
+
|param9desc     = Prevent Stacking?
|param9default=TRUE
+
|param9default = TRUE
|param10type =int  
+
|param10type   = int  
|param10name =bExcludeCreator
+
|param10name   = bExcludeCreator
|param10desc= {{undocumented}}
+
|param10desc   = {{undocumented}}
|param10default=FALSE
+
|param10default = FALSE
|returntype = void
+
|returntype     = void
|returndesc =  
+
|returndesc     =  
|sourcefile = ability_h
+
|sourcefile     = ability_h
|sourcemodule = Core Resources
+
|sourcemodule   = Core Game Resources
 
}}
 
}}
  

Revision as of 20:22, 3 August 2011

Wrapper for ApplyEffectOnObject on an array of Objects

void Ability_ApplyRandomDurationEffectOnObjectArray(
int nDurationType,
effect eEffect,
object[] arTarget,
float fDurationMin = 0.0,
float fDurationMax = 0.0,
object oCreator = OBJECT_SELF keyword,
int nAbilityId = 0,
int bSendAttackedEvent = FALSE,
int bPreventStacking = TRUE,
int bExcludeCreator = FALSE
);
Parameters:
nDurationType
will only accept EFFECT_DURATION_TYPE_TEMPORARY.
eEffect
the effect to be applied
arTarget
the targets of the effect
fDurationMin
minimum duration of the effect
fDurationMax
maximum duration of the effect
oCreator
effect creator
nAbilityId
The ability ID of the effect (Important for dispelling!!!)
bSendAttackedEvent
Whether to send an attacked event as well.
bPreventStacking
Prevent Stacking?
bExcludeCreator
[Undocumented]
Returns:

Nothing.

Source:

Core Game Resources.ability_h



See also

Ability_ApplyEffectOnObjectArray