Difference between revisions of "Engine ApplyEffectOnObject"
From Dragon Age Toolset Wiki
(Generated by Sunjammer's Dragon Age Script Paser) |
m (Correcting category, adding remarks) |
||
| (8 intermediate revisions by 3 users not shown) | |||
| 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 = an [[EFFECT_DURATION_TYPE_*]] constant or literal |
| − | |param2type=effect | + | |param1default = |
| − | |param2name=eEffect | + | |param2type = effect |
| − | |param2desc=the effect to be applied | + | |param2name = eEffect |
| − | |param3type=object | + | |param2desc = the effect to be applied |
| − | |param3name=oTarget | + | |param2default = |
| − | |param3desc=the target of the effect | + | |param3type = object |
| − | |param4type=float | + | |param3name = oTarget |
| − | |param4name=fDuration | + | |param3desc = the target of the effect |
| − | |param4desc= | + | |param3default = |
| − | |param5type=object | + | |param4type = float |
| − | |param5name=oCreator | + | |param4name = fDuration |
| − | |param5desc=effect creator | + | |param4desc = the duration in seconds (only for temporary effects) |
| − | |param6type=int | + | |param4default = 0.0 |
| − | |param6name=nAbilityId | + | |param5type = object |
| − | |param6desc=ability | + | |param5name = oCreator |
| − | |returntype=void | + | |param5desc = effect creator |
| − | |returndesc= | + | |param5default = OBJECT_SELF |
| − | |sourcefile=script.ldf | + | |param6type = int |
| − | |sourcemodule= | + | |param6name = nAbilityId |
| + | |param6desc = ability ID of the effect (important for dispelling) | ||
| + | |param6default = 0 | ||
| + | |returntype = void | ||
| + | |returndesc = | ||
| + | |sourcefile = script.ldf | ||
| + | |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. | + | Applies <code>eEffect</code> to <code>oTarget</code>. |
| − | < | + | If <code>nDurationType</code> is <code>EFFECT_DURATION_TYPE_TEMPORARY</code>, then <code>fDuration</code> is the duration of the effect. |
| + | |||
| + | Use [[core_h]].[[ApplyEffectToObject]] instead of calling this directly. | ||
| + | == Remarks == | ||
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
| − | + | The [[EFFECT_DURATION_TYPE_*]] constant which are valid for the <code>nDurationType</code> parameter are: | |
| + | * <code>EFFECT_DURATION_TYPE_INSTANTANEOUS</code> | ||
| + | * <code>EFFECT_DURATION_TYPE_PERMANENT</code> | ||
| + | * <code>EFFECT_DURATION_TYPE_TEMPORARY</code> | ||
<!-- == Examples == --> | <!-- == Examples == --> | ||
<!-- This section contains examples transcluded from the snippet library. --> | <!-- This section contains examples transcluded from the snippet library. --> | ||
| − | |||
<!-- == See also == --> | <!-- == See also == --> | ||
<!-- This section contains links to articles, functions or constant groups. --> | <!-- This section contains links to articles, functions or constant groups. --> | ||
| − | + | [[Category:Effect functions]] | |
| − | [[Category: Effect | + | |
Latest revision as of 19:59, 10 March 2012
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
- an EFFECT_DURATION_TYPE_* constant or literal
- eEffect
- the effect to be applied
- oTarget
- the target of the effect
- fDuration
- the duration in seconds (only for temporary effects)
- 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.
Remarks
The EFFECT_DURATION_TYPE_* constant which are valid for the nDurationType parameter are:
-
EFFECT_DURATION_TYPE_INSTANTANEOUS -
EFFECT_DURATION_TYPE_PERMANENT -
EFFECT_DURATION_TYPE_TEMPORARY
