Difference between revisions of "GetActorValue - Actor"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Lisselli
m (→‎Notes: Remove note about getting the maximum value(example, 250/400 - you would want 400.) as it's unknown how to get this value.)
 
(One intermediate revision by one other user not shown)
Line 32: Line 32:
== Notes ==
== Notes ==
*GetActorValue is slightly faster than GetAV as it is native.
*GetActorValue is slightly faster than GetAV as it is native.
*This function returns the current value as opposed to the base value. To get the base value see [[GetBaseActorValue - Actor]].
*This function returns the current value as opposed to the base (maximum) value. To get the base value see [[GetBaseActorValue - Actor]].
*This function will '''not''' return the maximum value of health, magicka or stamina. Only the current value. Currently it is unknown how to get the maximum value.


== See Also ==
== See Also ==
*[[GetBaseActorValue - Actor]]
*[[GetBaseActorValue - Actor]]
*[[GetActorValuePercentage - Actor]]
*[[GetActorValuePercentage - Actor]]
*[[GetActorValueMax - Actor]]
*[[DamageActorValue - Actor]]
*[[DamageActorValue - Actor]]
*[[ModActorValue - Actor]]
*[[ModActorValue - Actor]]

Latest revision as of 05:59, 30 May 2024

Member of: Actor Script

Gets the specified actor value from the actor.

Syntax[edit | edit source]

float Function GetActorValue(string asValueName) native
float Function GetAV(string asValueName)
  return GetActorValue(asValueName)
EndFunction

Parameters[edit | edit source]

Return Value[edit | edit source]

The value of the requested actor value.

Examples[edit | edit source]

; Obtain the player's current health actor value
Float fPlayerHealth = Game.GetPlayer().GetActorValue("Health")


; Obtain Bob's current Sneak actor value
Float fBobSneak = Bob.GetAV("Sneak")

Notes[edit | edit source]

  • GetActorValue is slightly faster than GetAV as it is native.
  • This function returns the current value as opposed to the base (maximum) value. To get the base value see GetBaseActorValue - Actor.

See Also[edit | edit source]