Difference between revisions of "Template:Stat/doc"

From RimWorld Wiki
Jump to navigation Jump to search
m
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
Creates the first line of a [[Stat]] page, displaying what it is, providing the description, categorizing the page and setting several page parameters.
 
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]].
 
The [[Capacity]] equivalent is [[Template: Capacity]].
  
<includeonly>[[Category:Templates]]</includeonly>
+
== Example ==
[[Category:Template documentation]]
+
=== No Table (Default) ===
 +
{{Stat
 +
| set property = 0
 +
| 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
 +
}}
 +
 
 +
=== 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>
 +
<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.