Difference between revisions of "Template:Stat"

From RimWorld Wiki
Jump to navigation Jump to search
m (Undo revision 151217 by JuliaCat (talk))
Tag: Undo
m (Additional parameters)
Line 5: Line 5:
 
  | 0 | no | n | f | false =
 
  | 0 | no | n | f | false =
 
  | #default =
 
  | #default =
   {{#set: Description       = {{{description|}}}
+
   {{#set: Description = {{{description|}}}
        | Stat Minimum      = {{{min value|}}}
+
| Def Name = {{{def name|}}}
        | Stat Maximum      = {{{max value|}}}
+
| Label = {{{label|}}}
        | Default Base Value = {{{default base value|}}}
+
| Stat Maximum = {{{max value|}}}<!-- 9999999 -->
        | To String Style   = {{{to string style|}}}
+
| Stat Minimum = {{{min value|}}}<!-- -9999999 -->
        | Health Type       = Stat
+
| Default Base Value = {{{default base value|}}}<!-- 1 -->
        | Effective Minimum = {{#expr: {{{effective minimum|}}} }}
+
| To String Style = {{{to string style|}}}
        | Effective Maximum = {{#expr: {{{effective maximum|}}} }}
+
| Health Type = Stat
 +
| Effective Minimum = {{#expr: {{{effective minimum|}}} }}
 +
| Effective Maximum = {{#expr: {{{effective maximum|}}} }}
 +
<!-- Strings -->
 +
| Offset Label = {{offset label|}}
 +
| Format String = {{format string|}}
 +
| Format String Unfinalized = {{format string unfinalized|}}
 +
| Stat Factors Explanation Header = {{stat factors explanation header|}}
 +
| Label For Full Stat List = {{label for full stat list|}}
 +
<!-- Booleans -->
 +
| Always Hide = {{always hide|}}
 +
| For Information Only = {{for information only|}}
 +
| Show On Animals = {{show on animals|true}}
 +
| Show On Default Value = {{show on default value|true}}
 +
| Show On Entities = {{show on entities|true}}
 +
| Show On Humanlikes = {{show on humanlikes|true}}
 +
| Show On Mechanoids = {{show on mechanoids|true}}
 +
| Show On Non Power Plants = {{show on non power plants|true}}
 +
| Show On Non Wild Man Humanlikes = {{show on non wild man humanlikes|true}}
 +
| Show On Non Work Tables = {{show on non work tables|true}}
 +
| Show On Pawns = {{show on pawns|true}}
 +
| Show On Player Mechanoids = {{show on player mechanoids|}}
 +
| Show On Slaves Only = {{show on slaves only|}}
 +
| Show On Unhaulables = {{show on unhaulables|true}}
 +
| Show On Untradeables = {{show on untradeables|true}}
 +
| Show Zero Base Value = {{show zero base value|}}
 +
| Display Priority In Category = {{display priority in category|}}
 +
    | To String Number Sense = {{to string number sense|Absolute}}
 +
| Worker Class = {{worker class|}}
 
   }}
 
   }}
 
   [[Category:{{#switch: {{{category|}}}
 
   [[Category:{{#switch: {{{category|}}}
    | BasicsImportant       = Stats - Important
+
| Important
    | BasicsPawnImportant   = Stats - Pawn Important
+
| Basics Important
    | BasicsNonPawnImportant = Stats - Non Pawn Important
+
| BasicsImportant = Stats - Important
    | Basics           = Stats - Basics
+
| Pawn Important
    | Pawn
+
| Basics Pawn Important
    | BasicsPawn       = Stats - Pawn
+
| BasicsPawnImportant = Stats - Pawn Important
    | Non Pawn
+
| NonPawnImportant
    | NonPawn
+
| Basics Non Pawn Important
    | BasicsNonPawn   = Stats - Non Pawn
+
| BasicsNonPawnImportant = Stats - Non Pawn Important
    | Terrain         = Stats - Terrain
+
| Basics   = Stats - Basics
    | Meditation       = Stats - Meditation
+
| Pawn
    | Mechanoid       = Stats - Mechanoid
+
| BasicsPawn   = Stats - Pawn
    | Apparel         = Stats - Apparel
+
| Non Pawn
    | Buildings
+
| NonPawn
    | Building         = Stats - Building
+
| BasicsNonPawn = Stats - Non Pawn
    | Ranged Weapon
+
| Terrain   = Stats - Terrain
    | Ranged
+
| Meditation   = Stats - Meditation
    | Weapon_Ranged   = Stats - Weapon (Ranged)
+
| Mechanoid = Stats - Mechanoid
    | Melee
+
| Apparel   = Stats - Apparel
    | Melee Weapon
+
| Buildings
    | Weapon_Melee     = Stats - Weapon (Melee)
+
| Building = Stats - Building
    | Ability         = Stats - Ability
+
| Ranged Weapon
    | Stuff Stat Factors
+
| Ranged
    | StuffStatFactors = Stats - Stuff Stat Factors
+
| Weapon_Ranged = Stats - Weapon (Ranged)
    | Mechanitor       = Stats - Mechanitor
+
| Melee
    | Pawn Combat
+
| Melee Weapon
    | PawnCombat       = Stats - Pawn Combat
+
| Weapon_Melee = Stats - Weapon (Melee)
    | Social
+
| Ability   = Stats - Ability
    | Pawn Social
+
| Stuff Stat Factors
    | PawnSocial       = Stats - Pawn Social
+
| StuffStatFactors = Stats - Stuff Stat Factors
    | Misc
+
| Mechanitor   = Stats - Mechanitor
    | Pawn Misc
+
| Pawn Combat
    | PawnMisc         = Stats - Pawn Misc
+
| PawnCombat   = Stats - Pawn Combat
    | Work
+
| Social
    | Pawn Work
+
| Pawn Social
    | PawnWork         = Stats - Pawn Work
+
| PawnSocial   = Stats - Pawn Social
    | Psychic Ritual
+
| Misc
    | PsychicRituals  = Stats - Psychic Ritual
+
| Pawn Misc
    | Containment     = Stats - Containment
+
| PawnMisc = Stats - Pawn Misc
    | Obsolete         = Stats - Obsolete
+
| Work
    | #default         = Stat}}]]
+
| Pawn Work
 +
| PawnWork = Stats - Pawn Work
 +
| Psychic Ritual
 +
| PsychicRituals  = Stats - Psychic Ritual
 +
| Containment   = Stats - Containment
 +
| Obsolete = Stats - Obsolete
 +
| #default = Stat}}]]
 
}}<!--
 
}}<!--
  
 
DISPLAY TEXT
 
DISPLAY TEXT
-->'''{{PAGENAME}}''' is a [[stat]]: {{Text | description | {{{description|}}} }} {{#if: {{{min value|}}} | Its minimum allowed value is {{Format Number|{{{min value|}}}|{{{to string style|}}} }}{{#if: {{{effective minimum|}}} | &nbsp;(effectively limited to {{Format Number|{{{effective minimum|}}}|{{{to string style|}}} }})}}.}} {{#if: {{{max value|}}} | Its maximum allowed value is {{Format Number|{{{max value|}}}|{{{to string style|}}} }}{{#if: {{{effective maximum|}}} | &nbsp;(effectively limited to {{Format Number|{{{effective maximum|}}}|{{{to string style|}}} }})}}.}} {{#if: {{{default base value|}}} | Its default value is {{Format Number|{{{default base value|}}}|{{{to string style|}}} }}.}}</includeonly><noinclude>{{Documentation}}</noinclude>
+
-->'''{{PAGENAME}}''' is a [[stat]]: {{Text | description | {{{description|}}} }} <!--
 +
-->{{#if: {{{min value|}}} | Its minimum allowed value is {{Format Number|{{{min value|}}}|{{{to string style|}}} }}<!--
 +
-->{{#if: {{{effective minimum|}}} | &nbsp;(effectively limited to {{Format Number|{{{effective minimum|}}}|{{{to string style|}}} }})}}.}} <!--
 +
-->{{#if: {{{max value|}}} | Its maximum allowed value is {{Format Number|{{{max value|}}}|{{{to string style|}}} }}<!--
 +
-->{{#if: {{{effective maximum|}}} | &nbsp;(effectively limited to {{Format Number|{{{effective maximum|}}}|{{{to string style|}}} }})}}.}} <!--
 +
-->{{#if: {{{default base value|}}} | Its default value is {{Format Number|{{{default base value|}}}|{{{to string style|}}} }}.}}</includeonly><noinclude>{{Documentation}}</noinclude>

Revision as of 02:56, 21 September 2024

Documentation icon Template documentation[view] [edit] [history] [purge]

Creates the first line of a Stat page, displaying what it is, providing the description, categorizing the page and setting several page parameters.

Note: Description placed in the template should match the description of the stat in-game. Additional information and context can be added later. Links can be made from the text in the description.

The Capacity equivalent is Template: Capacity.

Example

Stat is a stat: Speed at which this person sows and harvests plants. Its minimum allowed value is 10% (effectively limited to 11%). Its maximum allowed value is 100% (effectively limited to 90%). Its default value is 50%.