Difference between revisions of "ModActorValue - Actor"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Griffinsclaw
imported>Thingy Person
Line 9: Line 9:
Function ModActorValue(string asValueName, float afAmount) native
Function ModActorValue(string asValueName, float afAmount) native
Function ModAV(string asValueName, float afAmount)
Function ModAV(string asValueName, float afAmount)
  ModActorValue(asValueName, afAmount)
EndFunction
</source>
</source>



Revision as of 16:49, 29 June 2013

Member of: Actor Script

Modifies the specified actor value on the actor.

Syntax

Function ModActorValue(string asValueName, float afAmount) native
Function ModAV(string asValueName, float afAmount)
  ModActorValue(asValueName, afAmount)
EndFunction

Parameters

  • asValueName: The name of the actor value to modify. Actor Value List
  • afAmount: How much to modify the value by.

Return Value

None.

Examples

; Modify the player's current health actor value by 10
Game.GetPlayer().ModActorValue("health", 10.0)


; Modify Jake's current health actor value by -5.0
Actor Jake= Jake_Alias.GetReference() as Actor
Jake.ModAV("Health", -5.0)

Notes

  • This function modifies the current value as opposed to the base value.
  • ModActorValue() with a negative number is equivalent to DamageActorValue() (not always true, see talk)
  • ModActorValue() with a positive number is equivalent to RestoreActorValue() except that RestoreActorValue will not set the current value higher than the base value.

See Also