Difference between revisions of "Engine ApplyEffectAtLocation"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (1 revision: re-import with default parameter value parameters set)
m (refix)
Line 1: Line 1:
{{Generated with errors}}
 
 
{{dafunction
 
{{dafunction
 
|name=Engine_ApplyEffectAtLocation
 
|name=Engine_ApplyEffectAtLocation
Line 5: Line 4:
 
|param1type=int
 
|param1type=int
 
|param1name=nDurationType
 
|param1name=nDurationType
|param1desc=can be EFFECT_DURATION_TYPE_PERMANENT EFFECT_DURATION_TYPE_INSTANTANEOUS or EFFECT_DURATION_TYPE_TEMPORARY
+
|param1desc=can be [[EFFECT_DURATION_TYPE_PERMANENT]], [[EFFECT_DURATION_TYPE_INSTANTANEOUS]] or [[EFFECT_DURATION_TYPE_TEMPORARY]]
 
|param1default=
 
|param1default=
 
|param2type=effect
 
|param2type=effect
Line 13: Line 12:
 
|param3type=location
 
|param3type=location
 
|param3name=lLocation
 
|param3name=lLocation
|param3desc=
+
|param3desc=the location at which the effect is applied
 
|param3default=
 
|param3default=
 
|param4type=float
 
|param4type=float
Line 35: Line 34:
 
== 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 vLocation.  If nDurationType is EFFECT_DURATION_TYPE_TEMPORARY, then fDuration is the duration of the effect.  
+
Applies eEffect to lLocation.  If nDurationType is EFFECT_DURATION_TYPE_TEMPORARY, then fDuration is the duration of the effect.  
  
 
<!-- == Remarks == -->
 
<!-- == Remarks == -->

Revision as of 23:12, 31 July 2009

This function applies an effect at a location.

void Engine_ApplyEffectAtLocation(
int nDurationType,
effect eEffect,
location lLocation,
float fDuration = 0.0,
object oCreator = OBJECT_SELF,
int nAbilityId = 0
);
Parameters:
nDurationType
can be EFFECT_DURATION_TYPE_PERMANENT, EFFECT_DURATION_TYPE_INSTANTANEOUS or EFFECT_DURATION_TYPE_TEMPORARY
eEffect
the effect to be applied
lLocation
the location at which the effect is applied
fDuration
this value needs to be set only when nDurationType is EFFECT_DURATION_TYPE_TEMPORARY
oCreator
effect creator
nAbilityId
ability id
Returns:

Nothing.

Source:

script.ldf

Description

Applies eEffect to lLocation. If nDurationType is EFFECT_DURATION_TYPE_TEMPORARY, then fDuration is the duration of the effect.