Difference between revisions of "DamageActorValue - Actor"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Thingy Person
imported>Thingy Person
Line 7: Line 7:
== Syntax ==
== Syntax ==
<source lang="papyrus">
<source lang="papyrus">
Function DamageActorValue(string asValueName, float afDamage) nativeFunction
Function DamageActorValue(string asValueName, float afDamage) native
DamageAV(string asValueName, float afDamage)
Function DamageAV(string asValueName, float afDamage)
   DamageActorValue(asValueName, afDamage)
   DamageActorValue(asValueName, afDamage)
EndFunction
EndFunction

Revision as of 10:34, 9 August 2013

Member of: Actor Script

Applies damage to the specified actor value on this actor.

Syntax

Function DamageActorValue(string asValueName, float afDamage) native
Function DamageAV(string asValueName, float afDamage)
  DamageActorValue(asValueName, afDamage)
EndFunction

Parameters

  • asValueName: The name of the actor value to damage. Actor Value List
  • afDamage: The amount of damage to apply to the actor value.

Return Value

None.

Examples

; Damage the player's health 10 points
Game.GetPlayer().DamageActorValue("Health", 10.0)


; Damage Bob's health 5 points
Actor Bob = Bob_Alias.GetReference() As Actor
Bob.DamageAV("Health", 5.0)

Notes

  • This function modifies the current value as opposed to the base value.
  • DamageActorValue() is equivalent to ModActorValue() with a negative number.
  • Negative numbers will be converted to positive so -100 and 100 will have the same effect.

See Also