Difference between revisions of "Template:Stat"

From RimWorld Wiki
Jump to navigation Jump to search
m (Nullified "Show Developmental Stage Filter" Default Value to remove some clutter, at least until all Stats have this property filled out)
m (Integrate Format String into output text)
Line 79: Line 79:
 
| To String Style Unfinalized = {{{to string style unfinalized|}}}<!--ToStringStyle?-->
 
| To String Style Unfinalized = {{{to string style unfinalized|}}}<!--ToStringStyle?-->
 
| Mutable Stats = {{{mutable stats|}}}<!--Hashset<StatDef>-->
 
| Mutable Stats = {{{mutable stats|}}}<!--Hashset<StatDef>-->
| Show Developmental Stage Filter = {{{show developmental stage filter|<!--Baby, Child, Adult-->}}}<!-- Default = DevelopmentalStage.Baby | DevelopmentalStage.Child | DevelopmentalStage.Adult --><!--DevelopmentalStage-->
+
| Show Developmental Stage Filter = {{{show developmental stage filter|Baby, Child, Adult}}}<!-- Default = DevelopmentalStage.Baby | DevelopmentalStage.Child | DevelopmentalStage.Adult --><!--DevelopmentalStage-->
 
| Post Process Curve = {{{post process curve|}}}<!--SimpleCurve-->
 
| Post Process Curve = {{{post process curve|}}}<!--SimpleCurve-->
 
| Disable If Skill Disabled = {{{disable if skill disabled|}}}<!--SkillDef-->
 
| Disable If Skill Disabled = {{{disable if skill disabled|}}}<!--SkillDef-->
Line 87: Line 87:
 
| Worker Class = {{{worker class|}}}<!-- Default = typeof(StatWorker) --><!--Type-->
 
| Worker Class = {{{worker class|}}}<!-- Default = typeof(StatWorker) --><!--Type-->
 
   }}
 
   }}
 +
  <!--{{#if:{{#expr:{{{P|Always Hide}}} = true}}|[[Category:Stats - Always Hide]]}}
 +
  {{#if:{{#expr:{{{P|For Information Only}}} = true}}|[[Category:Stats - For Information Only]]}}-->
 
   [[Category:{{#switch: {{{category|}}}
 
   [[Category:{{#switch: {{{category|}}}
 
| Important
 
| Important
Line 139: Line 141:
 
DISPLAY TEXT
 
DISPLAY TEXT
 
-->'''{{PAGENAME}}''' is a [[stat]]: {{Text | description | {{{description|}}} }} <!--
 
-->'''{{PAGENAME}}''' is a [[stat]]: {{Text | description | {{{description|}}} }} <!--
-->{{#if: {{{min value|}}} | Its minimum allowed value is {{Format Number|{{{min value|}}}|{{{to string style|}}} }}<!--
+
-->{{#if: {{{min value|}}} | Its minimum allowed value is <!--
-->{{#if: {{{effective minimum|}}} | &nbsp;(effectively limited to {{Format Number|{{{effective minimum|}}}|{{{to string style|}}} }})}}.}} <!--
+
-->{{#if: {{{format string|}}} | {{#invoke:String|replace|{{{format string|}}}|{0}|{{Format Number|{{{min value|}}}|{{{to string style|}}}}}}} | {{Format Number|{{{min value|}}}|{{{to string style|}}} }} }}<!--
-->{{#if: {{{max value|}}} | Its maximum allowed value is {{Format Number|{{{max value|}}}|{{{to string style|}}} }}<!--
+
-->{{#if: {{{effective minimum|}}} | &nbsp;(effectively limited to <!--
-->{{#if: {{{effective maximum|}}} | &nbsp;(effectively limited to {{Format Number|{{{effective maximum|}}}|{{{to string style|}}} }})}}.}} <!--
+
-->{{#if: {{{format string|}}} | {{#invoke:String|replace|{{{format string|}}}|{0}|{{Format Number|{{{effective minimum|}}}|{{{to string style|}}}}}}} | {{Format Number|{{{effective minimum|}}}|{{{to string style|}}} }} }})}}.}} <!--
-->{{#if: {{{default base value|}}} | Its default value is {{Format Number|{{{default base value|}}}|{{{to string style|}}} }}.}}</includeonly><noinclude>{{Documentation}}</noinclude>
+
-->{{#if: {{{max value|}}} | Its maximum allowed value is <!--
 +
-->{{#if: {{{format string|}}} | {{#invoke:String|replace|{{{format string|}}}|{0}|{{Format Number|{{{max value|}}}|{{{to string style|}}}}}}} | {{Format Number|{{{max value|}}}|{{{to string style|}}} }} }}<!--
 +
-->{{#if: {{{effective maximum|}}} | &nbsp;(effectively limited to <!--
 +
-->{{#if: {{{format string|}}} | {{#invoke:String|replace|{{{format string|}}}|{0}|{{Format Number|{{{effective maximum|}}}|{{{to string style|}}}}}}} | {{Format Number|{{{effective maximum|}}}|{{{to string style|}}} }} }})}}.}} <!--
 +
-->{{#if: {{{default base value|}}} | Its default value is <!--
 +
-->{{#if: {{{format string|}}} | {{#invoke:String|replace|{{{format string|}}}|{0}|{{Format Number|{{{default base value|}}}|{{{to string style|}}}}}}} | {{Format Number|{{{default base value|}}}|{{{to string style|}}} }} }}.}}</includeonly><noinclude>{{Documentation}}</noinclude>

Revision as of 16:13, 21 October 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

No Table (Default)

Stat is a stat: Speed of movement in cells per second. Its minimum allowed value is 0.15 c/s. Its default value is 3 c/s.

Table

Stat is a stat: Speed of movement in cells per second. Its minimum allowed value is 0.15 c/s. Its default value is 3 c/s.