Difference between revisions of "Effect"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) |
m (Fixing links, fixing category) |
||
| Line 1: | Line 1: | ||
{{dafunction | {{dafunction | ||
| − | |name=Effect | + | |name = Effect |
| − | |brief= | + | |brief = Basic effect constructor. |
| − | |param1type=int | + | |param1type = int |
| − | |param1name=nType | + | |param1name = nType |
| − | |param1desc= | + | |param1desc = an [[EFFECT_TYPE_*]] constant or literal |
| − | |param1default=EFFECT_TYPE_INVALID | + | |param1default = EFFECT_TYPE_INVALID |
| − | |returntype=effect | + | |returntype = effect |
| − | |returndesc=a blank effect | + | |returndesc = a blank 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 | + | Creates an basic effect of the specified type. |
| − | + | == Remarks == | |
| − | + | ||
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
| − | + | The basic effect constructor can be used to create any type of effect however it does not set any of the effect's other parameters so the effect returned may be incomplete. If an effect has additional parameters these would have to be set using [[SetEffectFloat]], [[SetEffectInteger]], etc. Therefore, for pre-existing effects such as damage or heal it is better to use the appropriate constructor, namely, [[EffectDamage]] or [[EffectHeal]]. | |
<!-- == 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. --> | ||
| − | [[ | + | * [[Effect keyword]] |
| − | [[Category: Effect | + | [[Category:Effect functions]] |
Latest revision as of 20:40, 10 March 2012
Basic effect constructor.
- Parameters:
- nType
- an EFFECT_TYPE_* constant or literal
- Returns:
- a blank effect
- Source:
- script.ldf
Description
Creates an basic effect of the specified type.
Remarks
The basic effect constructor can be used to create any type of effect however it does not set any of the effect's other parameters so the effect returned may be incomplete. If an effect has additional parameters these would have to be set using SetEffectFloat, SetEffectInteger, etc. Therefore, for pre-existing effects such as damage or heal it is better to use the appropriate constructor, namely, EffectDamage or EffectHeal.
