Difference between revisions of "DamageActorValue"
Jump to navigation
Jump to search
imported>Geckbot m (Robot: Automated text replacement (-\[\[Category:(.*?)\(GECK 1.0\)\]\] +Category:\1(GECK 1.1))) |
imported>Joshua121 |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
==''' | {{Function | ||
|origin = GECK1 | |||
|summary = '''DamageActorValue''' is called on a Reference and takes two parameters, an [[Actor Values|ActorValue]] and a value. The Function alters the damage modifier of a given actor value. The damage modifier is always a negative number, or zero if there is no damage to the actor value. DamageActorValue will decrease the modifier by the given amount. | |||
|name = DamageActorValue | |||
== | |alias = DamageAV | ||
|returnType = void | |||
|referenceType = [ActorRefID] | |||
|arguments = | |||
{{FunctionArgument | |||
|Name = [[ActorValue]] | |||
= | |Type = string | ||
}}{{FunctionArgument | |||
BuddyRef.DamageActorValue Health 5 | |Name = Value | ||
|Type = <nowiki>int|float</nowiki> | |||
}} | |||
|example = BuddyRef.DamageActorValue Health 5 | |||
For example, suppose you have an NPC with 10 points of health as the current reference. If Buddy has 10 points of health, then this would subtract 5 from the damage modifier and now [[GetActorValue]] health returns 5. | For example, suppose you have an NPC with 10 points of health as the current reference. If Buddy has 10 points of health, then this would subtract 5 from the damage modifier and now [[GetActorValue]] health returns 5. | ||
}} | |||
== | ==Notes== | ||
*Function also accepts floating point numbers. | *Function also accepts floating point numbers. | ||
* '''DamageActorValue''' is always a negative number or zero, use [[RestoreActorValue]] to get the opposite effect. | |||
* '''DamageActorValue''' changes are non-permanent. For permanent changes use [[ModActorValue]]. | |||
[[ModActorValue]] | |||
== | ==See Also== | ||
*[[Stats List]] | |||
*[[ForceActorValue]] | |||
*[[GetActorValue]] | |||
*[[GetActorValueInfo]] | |||
*[[GetBaseActorValue]] | |||
*[[ModActorValue]] | |||
*[[RestoreActorValue]] | |||
*[[SetActorValue]] | |||
[[Category:Functions]] | [[Category:Functions]] | ||
Latest revision as of 14:37, 11 March 2012
< [[::Category:Functions|Category:Functions]]
A function included in the GECK version 1.1.0.36.
Description
DamageActorValue is called on a Reference and takes two parameters, an ActorValue and a value. The Function alters the damage modifier of a given actor value. The damage modifier is always a negative number, or zero if there is no damage to the actor value. DamageActorValue will decrease the modifier by the given amount.
Syntax
[ActorRefID].DamageActorValue ActorValue:string Value:int|float
Or:
[ActorRefID].DamageAV ActorValue:string Value:int|float
Example
BuddyRef.DamageActorValue Health 5
For example, suppose you have an NPC with 10 points of health as the current reference. If Buddy has 10 points of health, then this would subtract 5 from the damage modifier and now GetActorValue health returns 5.
Notes
- Function also accepts floating point numbers.
- DamageActorValue is always a negative number or zero, use RestoreActorValue to get the opposite effect.
- DamageActorValue changes are non-permanent. For permanent changes use ModActorValue.