Difference between revisions of "Category:Actor Value Functions"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>JOG
m
imported>JRoush
m (changed 'Offset' to 'Script' to reflect OBSE useage)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
There are several functions to access and modify an actor's stats.
There are several functions to access and modify an actor's [[Stats_List|stats]].


{|border="1" cellpadding="5" cellspacing="0"  
{|border="1" cellpadding="5" cellspacing="0"  
Line 7: Line 7:
! style="background:#efefef;" | <center> Stat Color</center>  
! style="background:#efefef;" | <center> Stat Color</center>  
|-
|-
|'''Get''' the unmodified '''base value'''
|'''Get''' the '''Calculated Base value'''
(At full health without any modifiers)
(value from base form + calculated factor from game settings, other AVs, etc.)
|[[GetBaseActorValue]] / [[GetBaseActorValue|GetBaseAv]]
|[[GetBaseActorValue]] / [[GetBaseActorValue|GetBaseAv]]
|<center>-</center>  
|<center>-</center>  
|-
|-
|'''Get''' the '''current''' ingame value
|'''Set''' the the '''Base value''' to a specific number
(Including damage and all magical modifiers)
(the value from the base form, with no modifiers or calculated factors)
|[[SetActorValue]] / [[SetActorValue|SetAv]]
|<center><font color="Blue">Blue</font></center>
<center> ("Unmodified")</center>
|-
|'''Get''' the '''Current value'''
(Including all modifiers and calculated factors)
|[[GetActorValue]] / [[GetActorValue|GetAv]]
|[[GetActorValue]] / [[GetActorValue|GetAv]]
|<center>-</center>
|<center>-</center>
|-
|-
|'''Set''' the stat's '''base value''' to a specific number
|'''Set''' the '''Current value''' to a specific number
(before any other modifiers apply)
(The ''console'' version changes the Damage modifier, the ''script'' version changes the Script modifier)
|[[SetActorValue]] / [[SetActorValue|SetAv]]
|<center><font color="Blue">Blue</font></center>
<center> ("Unmodified")</center>
|-
|'''Set''' the '''current''' ingame value to a specific number
(Including damage and magical modifiers)
|[[ForceActorValue]] / [[ForceActorValue|ForceAv]]
|[[ForceActorValue]] / [[ForceActorValue|ForceAv]]
|<center><font color="Red">Red</font> / <font color="Green">Green</font></center>  
|<center><font color="Red">Red</font> / <font color="Green">Green</font> / <font color="Blue">Blue</font></center>  
<center>("Modified")</center>   
<center>("Modified" / "Restored")</center>   
|-
|-
|'''Add''' a certain value to the '''current value'''
|'''Add''' a certain value to the '''Current value'''
(In addition to damage and magical modifiers)
(The ''console'' version changes the Damage modifier, the ''script'' version changes the Script modifier)
|[[ModActorValue]] / [[ModActorValue|ModAv]]
|[[ModActorValue]] / [[ModActorValue|ModAv]]
|<center><font color="Red">Red</font> / <font color="Green">Green</font></center>  
|<center><font color="Red">Red</font> / <font color="Green">Green</font> / <font color="Blue">Blue</font></center>  
<center>("Modified")</center>  
<center>("Modified" / "Restored")</center>
|-
|'''Add''' a certain value to the '''Current value'''
(Changes the Damage modifier)
|[[ModActorValue2]] / [[ModActorValue2|ModAv2]]
; (OBSE)
|<center><font color="Red">Red</font> / <font color="Blue">Blue</font></center>
<center>("Damaged" / "Restored")</center>  
|}
|}


 
See the [[Actor Values]] page for details on the various Modifiers.
 
'''Notes:'''
 
*The value you see in game is the '''base value''' plus three modifiers:
#'''Game Modifier''' used for "permanent" effects such as Damage and Restore.
#'''Magic Modifier''' used for used for "temporary", ''dispellable'' magic-effects such as Drain and Fortify.
#'''Script Modifier''' used for "temporary" ''non-dispellable'' scripted-effects like blessings and curses. [[ModActorValue]] changes only the script modifier.
 
 
*Changes done by these functions can't be undone by ingame means like natural healing or magic. You need to undo them by script.
 
 
*In a script these Functions behave like described above, in the console they show a different behavior because they were used by Bethesda for testing purposes. See the explanations for [[ModActorValue]].


[[Category: Function Types]]
[[Category: Function Types]]
[[Category: Statistics Functions]]
[[Category: Statistics Functions]]

Latest revision as of 22:58, 9 November 2011

There are several functions to access and modify an actor's stats.

Usage
Function
Stat Color
Get the Calculated Base value

(value from base form + calculated factor from game settings, other AVs, etc.)

GetBaseActorValue / GetBaseAv
-
Set the the Base value to a specific number

(the value from the base form, with no modifiers or calculated factors)

SetActorValue / SetAv
Blue
("Unmodified")
Get the Current value

(Including all modifiers and calculated factors)

GetActorValue / GetAv
-
Set the Current value to a specific number

(The console version changes the Damage modifier, the script version changes the Script modifier)

ForceActorValue / ForceAv
Red / Green / Blue
("Modified" / "Restored")
Add a certain value to the Current value

(The console version changes the Damage modifier, the script version changes the Script modifier)

ModActorValue / ModAv
Red / Green / Blue
("Modified" / "Restored")
Add a certain value to the Current value

(Changes the Damage modifier)

ModActorValue2 / ModAv2
(OBSE)
Red / Blue
("Damaged" / "Restored")

See the Actor Values page for details on the various Modifiers.