Difference between revisions of "EffectAreaOfEffect"
From Dragon Age Toolset Wiki
m (Correcting category) |
m (Fixing parameters) |
||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
| − | |name=EffectAreaOfEffect | + | |name = EffectAreaOfEffect |
| − | |brief=Create an | + | |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]] |
| − | |param1default= | + | |param1default = |
| − | |param2type=resource | + | |param2type = resource |
| − | |param2name=rScript | + | |param2name = rScript |
| − | |param2desc= | + | |param2desc = The AOE event handler script |
| − | |param2default= | + | |param2default = |
| − | |param3type=int | + | |param3type = int |
| − | |param3name=nAoEVfx | + | |param3name = nAoEVfx |
| − | |param3desc= | + | |param3desc = The ID of a visual effect in visual from [[VFX_ 2da]] |
| − | |param3default=0 | + | |param3default = 0 |
| − | |returntype=effect | + | |returntype = effect |
| − | |returndesc= | + | |returndesc = An area of effect. |
| − | |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. --> | + | Creates an area of effect (AOE), optionally with an embedded visual effect (VFX) that is synced to the lifetime of the AOE. |
| − | Creates an | + | <!-- == Remarks == --><!-- This section contains additional comments, observations and known issues. --> |
| − | + | <!-- == Examples == --><!-- This section contains examples transcluded from the snippet library. --> | |
| − | <!-- == Remarks == --> | + | <!-- == See also == --><!-- This section contains links to articles, functions or constant groups. --> |
| − | <!-- 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 functions]] | [[Category:Effect functions]] | ||
Latest revision as of 20:39, 5 April 2015
Create an area of effect.
- 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.
