Difference between revisions of "GetActorValue - Actor"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Thingy Person
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.)
Line 33: Line 33:
*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 value. To get the base value see [[GetBaseActorValue - Actor]].
*[[GetBaseActorValue - Actor]] returns the possible max value of a stat BEFORE buffs. To get the player's current percent of a stat after buffs (with examples how to get the max buffed value or a percent of the max buffed value of a stat as well), see [[GetActorValuePercentage - 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 ==

Revision as of 09:08, 11 July 2017

Member of: Actor Script

Gets the specified actor value from the actor.

Syntax

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

Parameters

Return Value

The value of the requested actor value.

Examples

; 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

  • 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 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