Background for Skyrim SE
Member of the Actor script
voidfunctionForceActorValue(stringasValueName, floatafNewValue)Native

Description

Wiki Description

Forces the specified actor value to the passed-in value.

Documentation Comment

Force the specified actor value to a specified value


Caveats

CK Wiki - Notes

  • This function modifies the current value as opposed to the base value. To set the base value, see Actor.SetActorValue(...).
    • To elaborate on that a bit, this function modifies the "permanent modifier" described in the Actor Value documentation, and that affects how the current value is computed. If an actor has a base health of 125 and you force their health to 0, then the permanent modifier will be set to -125, and their current health will become 0. If you then set the base health to 150, they will still have a permanent modifier of -125, so their current health will instantly become 25 (150 - 125).

Parameters

  1. stringasValueName

    CK Wiki Description

    The name of the actor value to force. Actor Value List

  2. floatafNewValue

    CK Wiki Description

    The new value to force the actor value to.


Examples

; Force the player's health to 50
Game.GetPlayer().ForceActorValue("health", 50.0)
; Force Jake's health to 10
Jake.ForceAV("Health", 10.0)

Auto-Generated Example

string myString__asValueName
float myFloat__afNewValue

myActor__toCallFunctionOn.ForceActorValue(myString__asValueName, myFloat__afNewValue)

Related Pages


Additional References

View this function’s page on the Skyrim Creation Kit Wiki

Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.