Difference between revisions of "SetActorValue"
Jump to navigation
Jump to search
imported>DewiMorgan m (Removing duplicate data.) |
imported>Gribbleshnibit8 (Updated page information. Used standard function template) |
||
Line 1: | Line 1: | ||
{{ | {{Function | ||
|CSWikiPage = SetActorValue | |||
|origin = GECK1 | |||
|summary = SetActorValue sets the stat's base value to the new value. | |||
See [[Stats List]] for a list of stats that can be accessed using SetActorValue. | See [[Stats List]] for a list of stats that can be accessed using SetActorValue. | ||
|name = SetActorValue | |||
|alias = SetAV | |||
|referenceType = Actor | |||
|arguments = | |||
{{FunctionArgument | |||
|Name = StatName | |||
|Type = string | |||
}}{{FunctionArgument | |||
|Name = Value | |||
|Type = int | |||
}} | |||
|example = Player.SetActorValue "Health" 3 | |||
}} | |||
== Notes == | |||
* Although called on a reference, this function actually changes the value on the base actor (thus the base value on all references of that base actor). Note also that ModActorValue modifies the stat value only on the reference, and so is usually preferable. | |||
* For the player, this will not modify base health. Base health is determined by (Endurance * fPCBaseHealthMult). For example, a level 2 player with 40 Endurance will have 80 base health (40 * 2 = 80) and 4 more health (from the Endurance level bonus). If you use player.SetAv Health 100 the player will have 180 total health - 80 from base health, and 100 for the rest. | |||
== See Also == | |||
[[Stats List]]<br> | [[Stats List]]<br> | ||
[[ForceActorValue]]<br> | [[ForceActorValue]]<br> |
Revision as of 16:34, 28 November 2014
< [[::Category:Functions|Category:Functions]]
Link to TES4 Construction Set Wiki: SetActorValue.
A function included in the GECK version 1.1.0.36.
Description
SetActorValue sets the stat's base value to the new value.
See Stats List for a list of stats that can be accessed using SetActorValue.
Syntax
Actor.SetActorValue StatName:string Value:int
Or:
Actor.SetAV StatName:string Value:int
Example
Player.SetActorValue "Health" 3
Notes
- Although called on a reference, this function actually changes the value on the base actor (thus the base value on all references of that base actor). Note also that ModActorValue modifies the stat value only on the reference, and so is usually preferable.
- For the player, this will not modify base health. Base health is determined by (Endurance * fPCBaseHealthMult). For example, a level 2 player with 40 Endurance will have 80 base health (40 * 2 = 80) and 4 more health (from the Endurance level bonus). If you use player.SetAv Health 100 the player will have 180 total health - 80 from base health, and 100 for the rest.
See Also
Stats List
ForceActorValue
GetActorValue
GetActorValueInfo
GetBaseActorValue
GetPermanentActorValue
ModActorValue
RestoreActorValue