Difference between revisions of "DamageActorValue"

From GECK

m (Robot: Automated text replacement (-\[\[Category:(.*?)\(GECK 1.0\)\]\] +Category:\1(GECK 1.1)))
Line 1: Line 1:
=='''Description'''==
+
{{Function
 
+
|origin = GECK1
'''[[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.
+
|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
=='''Syntax'''==
+
|alias = DamageAV
 
+
|returnType = void
[''ActorREF''.]DamageActorValue ''ActorValue'' ''Value''
+
|referenceType = [ActorRefID]
   or
+
|arguments =  
[''ActorREF''.]DamageAV ''ActorValue'' ''Value''
+
  {{FunctionArgument
 
+
  |Name = [[ActorValue]]
=='''Examples'''==
+
   |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'''==
+
==Notes==
 
*Function also accepts floating point numbers.
 
*Function also accepts floating point numbers.
  
 
+
==See Also==
=='''See Also'''==
+
*[[Stats List]]
[[Stats List]]<br>
+
*[[ForceActorValue]]
[[ForceActorValue]]<br>
+
*[[GetActorValue]]
[[GetActorValue]]<br>
+
*[[GetActorValueInfo]]
[[GetActorValueInfo]]<br>
+
*[[GetBaseActorValue]]
[[GetBaseActorValue]]<br>
+
*[[ModActorValue]]
[[ModActorValue]]<br>
+
*[[RestoreActorValue]]
[[RestoreActorValue]]<br>
+
*[[SetActorValue]]
[[SetActorValue]]
+
 
+
=='''Reference'''==
+
None provided.
+
<!-- [[DamageActorValue_Reference|List of functions that use DamageActorValue]]  (wiki) -->
+
  
 
[[Category:Functions]]
 
[[Category:Functions]]

Revision as of 07:02, 15 January 2011

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.

See Also

Personal tools