Difference between revisions of "EffectImpact"
From Dragon Age Toolset Wiki
(Generated by Sunjammer's Dragon Age Script Paser) |
m (Correcting category) |
||
(4 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | |||
{{dafunction | {{dafunction | ||
|name=EffectImpact | |name=EffectImpact | ||
Line 6: | Line 5: | ||
|param1name=fDamage | |param1name=fDamage | ||
|param1desc=Amount of damage to be applied | |param1desc=Amount of damage to be applied | ||
+ | |param1default= | ||
|param2type=object | |param2type=object | ||
|param2name=oWeapon | |param2name=oWeapon | ||
|param2desc=Weapon that applies the damage | |param2desc=Weapon that applies the damage | ||
+ | |param2default= | ||
|param3type=int | |param3type=int | ||
|param3name=nVfx | |param3name=nVfx | ||
|param3desc=Impact VFX to play. Default of 0 is no impact VFX | |param3desc=Impact VFX to play. Default of 0 is no impact VFX | ||
+ | |param3default=0 | ||
|param4type=int | |param4type=int | ||
|param4name=nAbi | |param4name=nAbi | ||
|param4desc=Ability (default is invalid ability) | |param4desc=Ability (default is invalid ability) | ||
+ | |param4default=0 | ||
|param5type=int | |param5type=int | ||
|param5name=nDamageType | |param5name=nDamageType | ||
|param5desc=Damage Type to be applied (Physical, Fire): Default of 1 is physical | |param5desc=Damage Type to be applied (Physical, Fire): Default of 1 is physical | ||
+ | |param5default=1 | ||
|returntype=effect | |returntype=effect | ||
− | |returndesc= | + | |returndesc=An impact 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. --> | ||
EffectImpact Constructor. | EffectImpact Constructor. | ||
− | |||
<!-- == Remarks == --> | <!-- == Remarks == --> | ||
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
− | |||
<!-- == 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. --> | ||
− | [[Category: | + | [[Category:Effect functions]] |
Latest revision as of 20:02, 10 March 2012
EffectImpact Constructor.
effect EffectImpact(
float fDamage,
object oWeapon,
int nVfx = 0,
int nAbi = 0,
int nDamageType = 1
);
float fDamage,
object oWeapon,
int nVfx = 0,
int nAbi = 0,
int nDamageType = 1
);
- Parameters:
- fDamage
- Amount of damage to be applied
- oWeapon
- Weapon that applies the damage
- nVfx
- Impact VFX to play. Default of 0 is no impact VFX
- nAbi
- Ability (default is invalid ability)
- nDamageType
- Damage Type to be applied (Physical, Fire): Default of 1 is physical
- Returns:
- An impact effect
- Source:
- script.ldf
Description
EffectImpact Constructor.