Difference between revisions of "EffectAreaOfEffect"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (1 revision: Importing auto-generated function articles)
m (Fixing parameters)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{Generated with errors}}
 
 
{{dafunction
 
{{dafunction
−
|name=EffectAreaOfEffect
+
|name         = EffectAreaOfEffect
−
|brief=Create an AoEObject
+
|brief         = Create an area of effect.
−
|param1type=int
+
|param1type   = int
−
|param1name=nId
+
|param1name   = nId
−
|param1desc=
+
|param1desc   = The ID of an area of effect in [[persistent 2da]]
−
|param2type=resource
+
|param1default =  
−
|param2name=rScript
+
|param2type   = resource
−
|param2desc=
+
|param2name   = rScript
−
|param3type=int
+
|param2desc   = The AOE event handler script
−
|param3name=nAoEVfx
+
|param2default =  
−
|param3desc=
+
|param3type   = int
−
|returntype=effect
+
|param3name   = nAoEVfx
−
|returndesc=
+
|param3desc   = The ID of a visual effect in visual from [[VFX_ 2da]]
−
|sourcefile=script.ldf
+
|param3default = 0
−
|sourcemodule=
+
|returntype   = effect
 +
|returndesc   = An area of effect.
 +
|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. -->
+
Creates an area of effect (AOE), optionally with an embedded visual effect (VFX) that is synced to the lifetime of the AOE.
−
Creates an Area of Effect object, optionally with an embedded vfx that is synced
+
<!-- == Remarks ==  --><!-- This section contains additional comments, observations and known issues. -->
−
to the lifetime of the AoE Object.
+
<!-- == Examples == --><!-- This section contains examples transcluded from the snippet library. -->
−
Please refer to the documentation or talk to georg about how to use these, they work
+
<!-- == See also == --><!-- This section contains links to articles, functions or constant groups. -->
−
slightly different than in previous games!
+
  
−
<!-- == Remarks == -->
+
[[Category:Effect functions]]
−
<!-- This section contains additional comments, observations and known issues. -->
+
−
 
+
−
<!-- == Examples == -->
+
−
<!-- This section contains examples transcluded from the snippet library. -->
+
−
 
+
−
<!-- == See also == -->
+
−
<!-- This section contains links to articles, functions or constant groups. -->
+
−
 
+
−
[[Category: Effect access functions]]
+

Latest revision as of 20:39, 5 April 2015

Create an area of effect.

effect EffectAreaOfEffect(
int nId,
resource rScript,
int nAoEVfx = 0
);
Parameters:
nId
The ID of an area of effect in persistent 2da
rScript
The AOE event handler script
nAoEVfx
The ID of a visual effect in visual from VFX_ 2da
Returns:

An area of effect.

Source:

script.ldf

Description

Creates an area of effect (AOE), optionally with an embedded visual effect (VFX) that is synced to the lifetime of the AOE.

Retrieved from "http://www.datoolset.net/mw/index.php?title=EffectAreaOfEffect&oldid=19444"