Difference between revisions of "Actor Value"
added propert, some details, and templates.
imported>Qazaaq (fixed category to Miscellaneous) |
imported>Qazaaq (added propert, some details, and templates.) |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
'''Type:''' <code>AVIF</code> | |||
<BR/> | |||
'''Papyrus:''' [[ActorValue Script]] | '''Papyrus:''' [[ActorValue Script]] | ||
Actor Values are properties that exist on [[Actor|Actors]] and other [[ObjectReference Script|ObjectReferences]]. They are accessed and altered using Papyrus script functions, in the Console, and used in various forms in the Creation Kit. The [[Actor Value]] [[:Category:Object Classes|object]] is found within the [[Object Window]] under the [[:Category:Miscellaneous|Miscellaneous Category]]. | |||
Actor Values are properties that exist on Actors and other | |||
[[ | |||
== Editor Dialog == | == Editor Dialog == | ||
*''' | [[File:Actor Value Editor.png|thumb|right|400px]] | ||
*''' | *{{Template:Editor:Property:ID}} | ||
*'''In-Game Name:''' The name as it will appear in-game. | *'''Type''' | ||
*''' | **'''AI ATTRIBUTE:''' | ||
*''' | **'''CONDITION:''' | ||
* | **'''DERIVED ATTRIBUTE:''' | ||
**'''INT VALUE:''' | |||
**'''RESISTANCE:''' | |||
**'''RESOURCE:''' | |||
**'''SKILL:''' | |||
**'''SPECIAL (ATTRIBUTE):''' | |||
**'''VARIABLE:''' | |||
*{{Template:Editor:Property:Display Name|property=In-Game Name}} | |||
*'''Abbreviation:''' The abbreviated name as it will appear in-game. | |||
*'''Default Value:''' The default value of this [[Actor Value]]. | |||
**'''Derived:''' The value is read only as its value is derived from other values. | |||
*{{Template:Editor:Property:Description}} | |||
*'''Flags''' | *'''Flags''' | ||
**'''Minimum 1:''' | **'''Minimum 1:''' | ||
| Line 29: | Line 33: | ||
**'''Damage Is Positive:''' | **'''Damage Is Positive:''' | ||
*'''Additional Info:''' | *'''Additional Info:''' | ||
**'''Enumeration:''' The value represents an enumeration of values. | |||
{{ClearFloats}} | |||
== Hard-coded Actor Values == | |||
==Hard-coded Actor Values== | |||
There are a number of Actor Values that are defined in the code. This is because the code needs to be able to access them directly. In-game information about these Actor Values can be modified in the Creation Kit. You can see a list of Actor Values in the "Misc" section of the Object Window. There is a column that will show the word "HARDCODED" to let you know which Actor Values are hard-coded. | There are a number of Actor Values that are defined in the code. This is because the code needs to be able to access them directly. In-game information about these Actor Values can be modified in the Creation Kit. You can see a list of Actor Values in the "Misc" section of the Object Window. There is a column that will show the word "HARDCODED" to let you know which Actor Values are hard-coded. | ||
Hard-coded Actor Values generally include actor stats, such as Health, Action Points, limb conditions, SPECIALs, etc. | Hard-coded Actor Values generally include actor stats, such as Health, Action Points, limb conditions, SPECIALs, etc. | ||
==Editor-Defined Actor Values== | == Editor-Defined Actor Values == | ||
You can use the Creation Kit to create new Actor Values. Just right click in the Actor Value list in the Object Window and choose New or Duplicate, as with any other type of form. You give the Actor Value a unique name, which is its form ID, and have the option of specifying a default value for the Actor Value (this is normally 0.0). Once you've added a new Actor Value, it can be used elsewhere in the Creation Kit, in Papyrus or via the Console. | You can use the Creation Kit to create new Actor Values. Just right click in the Actor Value list in the Object Window and choose New or Duplicate, as with any other type of form. You give the Actor Value a unique name, which is its form ID, and have the option of specifying a default value for the Actor Value (this is normally 0.0). Once you've added a new Actor Value, it can be used elsewhere in the Creation Kit, in Papyrus or via the Console. | ||
==Actor Values on Actors and other Object References== | == Actor Values on Actors and other Object References == | ||
Most Actor Values are primarily used on Actors, but that's not required. If an Actor Value uses a formula to calculate the base value, the formula won't be used on a non-actor Object Reference. Instead, a base value of 0.0 will be used. | Most Actor Values are primarily used on Actors, but that's not required. If an Actor Value uses a formula to calculate the base value, the formula won't be used on a non-actor Object Reference. Instead, a base value of 0.0 will be used. | ||
==Actor Value functions in Papyrus== | == Actor Value functions in Papyrus == | ||
For a full list of Papyrus script functions involving Actor Values, see the [[ObjectReference Script|Object Reference]] documentation. | |||
On [[ObjectReference Script|Object References]]: | On [[ObjectReference Script|Object References]]: | ||
* Function [[DamageValue - ObjectReference|DamageValue]](ActorValue akAV, float afDamage) | * Function [[DamageValue - ObjectReference|DamageValue]](ActorValue akAV, float afDamage) | ||
| Line 84: | Line 90: | ||
**Get the Strength Actor Value | **Get the Strength Actor Value | ||
==Actor Value functions in the Console and Batch Files== | == Actor Value functions in the Console and Batch Files == | ||
These all work on the selected reference, or you can preface the function with "Reference.": | These all work on the selected reference, or you can preface the function with "Reference.": | ||
| Line 95: | Line 101: | ||
*GetValuePercent ACTORVALUE -- Returns the current value of ACTORVALUE on the Reference as a percentage of its max value, from 0-1. | *GetValuePercent ACTORVALUE -- Returns the current value of ACTORVALUE on the Reference as a percentage of its max value, from 0-1. | ||
==Reserved use Actor Values== | == Reserved use Actor Values == | ||
The actor values in this table are deprecated. Papyrus scripts using them should instead use new Actor Values created in the Creation Kit. | The actor values in this table are deprecated. Papyrus scripts using them should instead use new Actor Values created in the Creation Kit. | ||
| Line 137: | Line 143: | ||
|- | |- | ||
|} | |} | ||
== See Also == | == See Also == | ||
*[[:Category:Miscellaneous|Miscellaneous Category]] | *[[:Category:Miscellaneous|Miscellaneous Category]] | ||
[[Category: Papyrus]] | |||
[[Category:Editor Reference]] | |||
[[Category:Object Classes]] | |||
[[Category:Miscellaneous]] | |||