Difference between revisions of "Template:Stat/doc"

From RimWorld Wiki
Jump to navigation Jump to search
m
 
(One intermediate revision by the same user not shown)
Line 6: Line 6:
  
 
== Example ==
 
== Example ==
 +
=== No Table (Default) ===
 
{{Stat
 
{{Stat
 
| set property = 0
 
| set property = 0
| default base value = 0.5
+
| def name = MoveSpeed
| min value = 0.1
+
| label = move speed
| max value = 1
+
| description = Speed of movement in cells per second.
| effective minimum = 0.11
+
| default base value = 3.0
| effective maximum = 0.9
+
| min value = 0.15
| to string style = PercentZero
+
| format string = {0} c/s
| description = Speed at which this person sows and harvests [[plants]].
+
| to string style = FloatTwo
 +
| scenario randomizable = true
 +
| category = BasicsPawn
 +
| display priority in category = 2500
 +
| capacity factors = Moving
 +
| parts = StatPart_Glow, StatPart_RevenantSpeed
 +
}}
 +
 
 +
=== Table ===
 +
{{Stat
 +
| set property = 0
 +
| table = 1
 +
| def name = MoveSpeed
 +
| label = move speed
 +
| description = Speed of movement in cells per second.
 +
| default base value = 3.0
 +
| min value = 0.15
 +
| format string = {0} c/s
 +
| to string style = FloatTwo
 +
| scenario randomizable = true
 +
| category = BasicsPawn
 +
| display priority in category = 2500
 +
| capacity factors = Moving
 +
| parts = StatPart_Glow, StatPart_RevenantSpeed
 
}}
 
}}
  
 
<includeonly>[[Category:SMW templates]]</includeonly>
 
<includeonly>[[Category:SMW templates]]</includeonly>
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 18:57, 21 October 2024

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[edit]

No Table (Default)[edit]

Stat/doc 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[edit]

Stat

Speed of movement in cells per second.

Base Stats

Def Name
MoveSpeed
Label
move speed
Min Value
0.15
Default Base Value
3.0
To String Style
FloatTwo
Format String
{0} c/s

Other

Scenario Randomizable
true
Capacity Factors
Moving
Parts
StatPart_Glow, StatPart_RevenantSpeed
Display Priority In Category
2500

Stat/doc 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.