Difference between revisions of "Ability ApplyEffectOnObjectArray"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) |
m (Updating links) |
||
Line 1: | Line 1: | ||
{{dafunction | {{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= | + | |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= | + | |param4desc = this value needs to be set only when nDurationType is EFFECT_DURATION_TYPE_TEMPORARY |
− | |param4default=0. | + | |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 |
}} | }} | ||
Revision as of 20:27, 3 August 2011
Wrapper for ApplyEffectOnObject on an array of Objects
void Ability_ApplyEffectOnObjectArray(
int nDurationType,
effect eEffect,
object[] arTarget,
float fDuration = 0.0,
object oCreator = OBJECT_SELF,
int nAbilityId = 0,
int bSendAttackedEvent = FALSE,
int bPreventStacking = TRUE,
int bExcludeCreator = FALSE
);
int nDurationType,
effect eEffect,
object[] arTarget,
float fDuration = 0.0,
object oCreator = OBJECT_SELF,
int nAbilityId = 0,
int bSendAttackedEvent = FALSE,
int bPreventStacking = TRUE,
int bExcludeCreator = FALSE
);
- Parameters:
- nDurationType
- EFFECT_DURATION_TYPE_PERMANENT, EFFECT_DURATION_TYPE_INSTANT or EFFECT_DURATION_TYPE_TEMPORARY
- eEffect
- the effect to be applied
- arTarget
- the targets of the effect
- fDuration
- this value needs to be set only when nDurationType is EFFECT_DURATION_TYPE_TEMPORARY
- 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