GetActorValueModifier

From GECK
(Redirected from GetAVMod)
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Returns the net modifier of the specified Actor Value, gained from Effects (of any type) currently applied on the calling actor.

The 2nd argument typeFilter is optional, and may be used to instruct the function to return:

  • Only the permanent modifier (1)
  • Only the temporary modifier (2)
  • Both (3; default)

Syntax

[help]
(avMod:float) reference.GetActorValueModifier actorValue:StatName typeFilter:int 

Or:

(avMod:float) reference.GetAVMod actorValue:StatName typeFilter:int

Example

set fHealthModifier to CraigBooneRef.GetActorValueModifier Health 

Notes

  • "Effects" granted by skill Books are not applied as Effects, meaning this function will not account for permanent modifiers brought by them.

See Also