DamageActorValue - Actor

From Creation Kit
Jump to: navigation, search

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.
  • Negative numbers will be converted to positive so -100 and 100 will have the same effect.

See Also