Engine ApplyEffectOnObject - Revision history

Sunjammer: Correcting category, adding remarks

2012-03-10T18:59:28Z

Correcting category, adding remarks

Sunjammer at 19:34, 3 August 2011

2011-08-03T19:34:47Z

Sunjammer: Updating links

2011-08-03T19:30:48Z

Updating links

Yokmp: added param6desc information about dispelling

2011-02-27T04:53:11Z

added param6desc information about dispelling

BryanDerksen: fix link

2010-03-02T21:12:35Z

fix link

BryanDerksen: remove tag

2010-03-02T21:12:11Z

remove tag

Sunjammer: Generated by Sunjammer's Dragon Age Script Paser

2009-07-31T22:37:17Z

Generated by Sunjammer's Dragon Age Script Paser

BryanDerksen: 1 revision: re-import with default parameter value parameters set

2009-07-31T22:08:21Z

1 revision: re-import with default parameter value parameters set

BryanDerksen: 1 revision: Importing auto-generated function articles

2009-07-29T15:44:23Z

1 revision: Importing auto-generated function articles

Sunjammer: Generated by Sunjammer's Dragon Age Script Paser

2009-07-29T01:40:43Z

Generated by Sunjammer's Dragon Age Script Paser

New page

{{Generated}}
{{dafunction
|name=Engine_ApplyEffectOnObject
|brief=This function applies an effect on an object.
|param1type=int
|param1name=nDurationType
|param1desc=can be EFFECT_DURATION_TYPE_PERMANENT EFFECT_DURATION_TYPE_INSTANTANEOUS or EFFECT_DURATION_TYPE_TEMPORARY
|param2type=effect
|param2name=eEffect
|param2desc=the effect to be applied
|param3type=object
|param3name=oTarget
|param3desc=the target of the effect
|param4type=float
|param4name=fDuration
|param4desc=this value needs to be set only when nDurationType is EFFECT_DURATION_TYPE_TEMPORARY
|param5type=object
|param5name=oCreator
|param5desc=effect creator
|param6type=int
|param6name=nAbilityId
|param6desc=ability id
|returntype=void
|returndesc=
|sourcefile=script.ldf
|sourcemodule=
}}

== 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!










[[Category: Effect access functions]]

@@ Line 4: / Line 4: @@
 |param1type    = int
 |param1name    = nDurationType
-|param1desc    = [[EFFECT_DURATION_TYPE_*|EFFECT_DURATION_TYPE_PERMANENT]], [[EFFECT_DURATION_TYPE_*|EFFECT_DURATION_TYPE_INSTANT]] or [[EFFECT_DURATION_TYPE_*|EFFECT_DURATION_TYPE_TEMPORARY]]
+|param1desc    = an [[EFFECT_DURATION_TYPE_*]] constant or literal
 |param1default =
 |param2type    = effect
@@ Line 16: / Line 16: @@
 |param4type    = float
 |param4name    = fDuration
-|param4desc    = the duration in seconds (only required when nDurationType is [[EFFECT_DURATION_TYPE_*|EFFECT_DURATION_TYPE_TEMPORARY]])
+|param4desc    = the duration in seconds (only for temporary effects)
 |param4default = 0.0
 |param5type    = object
 |param5name    = oCreator
 |param5desc    = effect creator
-|param5default = [[OBJECT_SELF keyword|OBJECT_SELF]]
+|param5default = OBJECT_SELF
 |param6type    = int
 |param6name    = nAbilityId
@@ Line 31: / Line 31: @@
 |sourcemodule  =
 }}
 == Description ==
 <!-- 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.
+Applies <code>eEffect</code> to <code>oTarget</code>.
 Use [[core_h]].[[ApplyEffectToObject]] instead of calling this directly.
 == Remarks ==
-<!-- == Remarks == -->
 <!-- This section contains additional comments, observations and known issues. -->
+The [[EFFECT_DURATION_TYPE_*]] constant which are valid for the <code>nDurationType</code> parameter are:
 <!-- == Examples == -->
 <!-- This section contains examples transcluded from the snippet library. -->
 <!-- == See also == -->
 <!-- This section contains links to articles, functions or constant groups. -->
 [[Category:Effect functions]]
-[[Category: Effect access functions]]

@@ Line 16: / Line 16: @@
 |param4type    = float
 |param4name    = fDuration
-|param4desc    = a duration, in seconds, is only required when nDurationType is [[EFFECT_DURATION_TYPE_*|EFFECT_DURATION_TYPE_TEMPORARY]]
+|param4desc    = the duration in seconds (only required when nDurationType is [[EFFECT_DURATION_TYPE_*|EFFECT_DURATION_TYPE_TEMPORARY]])
 |param4default = 0.0
 |param5type    = object

@@ Line 1: / Line 1: @@
 {{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=can be [[EFFECT_DURATION_TYPE_PERMANENT]] [[EFFECT_DURATION_TYPE_INSTANT]] or [[EFFECT_DURATION_TYPE_TEMPORARY]]
+|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=this value needs to be set only when nDurationType is [[EFFECT_DURATION_TYPE_TEMPORARY]]
+|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 (Important for dispelling!)
+|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 ==
 <!-- 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.
 <!-- == Remarks == -->

@@ Line 4: / Line 4: @@
 |param1type=int
 |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_INSTANT]] or [[EFFECT_DURATION_TYPE_TEMPORARY]]
 |param1default=
 |param2type=effect

← Older revision	Revision as of 22:08, 31 July 2009
(No difference)

← Older revision	Revision as of 15:44, 29 July 2009
(No difference)