Difference between revisions of "Engine ApplyEffectOnObject"
From Dragon Age Toolset Wiki
m (added param6desc information about dispelling) |
m (Updating links) |
||
| Line 1: | Line 1: | ||
{{dafunction | {{dafunction | ||
| − | |name=Engine_ApplyEffectOnObject | + | |name = Engine_ApplyEffectOnObject |
| − | |brief=This function applies an effect on an object. | + | |brief = This function applies an effect on an object. |
| − | |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]] |
| − | |param1default= | + | |param1default = |
| − | |param2type=effect | + | |param2type = effect |
| − | |param2name=eEffect | + | |param2name = eEffect |
| − | |param2desc=the effect to be applied | + | |param2desc = the effect to be applied |
| − | |param2default= | + | |param2default = |
| − | |param3type=object | + | |param3type = object |
| − | |param3name=oTarget | + | |param3name = oTarget |
| − | |param3desc=the target of the effect | + | |param3desc = the target of the effect |
| − | |param3default= | + | |param3default = |
| − | |param4type=float | + | |param4type = float |
| − | |param4name=fDuration | + | |param4name = fDuration |
| − | |param4desc= | + | |param4desc = a duration, in seconds, is only required when nDurationType is [[EFFECT_DURATION_TYPE_*|EFFECT_DURATION_TYPE_TEMPORARY]] |
| − | |param4default=0.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=ability ID of the effect ( | + | |param6desc = ability ID of the effect (important for dispelling) |
| − | |param6default=0 | + | |param6default = 0 |
| − | |returntype=void | + | |returntype = void |
| − | |returndesc= | + | |returndesc = |
| − | |sourcefile=script.ldf | + | |sourcefile = script.ldf |
| − | |sourcemodule= | + | |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. --> | ||
| − | Applies eEffect to oTarget. If nDurationType is EFFECT_DURATION_TYPE_TEMPORARY, then fDuration is the duration of the effect. Use core_h.ApplyEffectToObject instead of calling this directly | + | Applies eEffect to oTarget. If nDurationType is EFFECT_DURATION_TYPE_TEMPORARY, then fDuration is the duration of the effect. |
| + | |||
| + | Use [[core_h]].[[ApplyEffectToObject]] instead of calling this directly. | ||
<!-- == Remarks == --> | <!-- == Remarks == --> | ||
Revision as of 20:30, 3 August 2011
This function applies an effect on an object.
void Engine_ApplyEffectOnObject(
int nDurationType,
effect eEffect,
object oTarget,
float fDuration = 0.0,
object oCreator = OBJECT_SELF,
int nAbilityId = 0
);
int nDurationType,
effect eEffect,
object oTarget,
float fDuration = 0.0,
object oCreator = OBJECT_SELF,
int nAbilityId = 0
);
- Parameters:
- nDurationType
- EFFECT_DURATION_TYPE_PERMANENT, EFFECT_DURATION_TYPE_INSTANT or EFFECT_DURATION_TYPE_TEMPORARY
- eEffect
- the effect to be applied
- oTarget
- the target of the effect
- fDuration
- a duration, in seconds, is only required when nDurationType is EFFECT_DURATION_TYPE_TEMPORARY
- oCreator
- effect creator
- nAbilityId
- ability ID of the effect (important for dispelling)
- Returns:
- Nothing.
- Source:
- script.ldf
Description
Applies eEffect to oTarget. If nDurationType is EFFECT_DURATION_TYPE_TEMPORARY, then fDuration is the duration of the effect.
Use core_h.ApplyEffectToObject instead of calling this directly.
