Difference between revisions of "Template:Stat"

From RimWorld Wiki
Jump to navigation Jump to search
m (Optional wip Infobox to display all properties)
m (Removed all default values to avoid clutter while adding missing parameters to many of the stats, and to verify that default values aren't overridden or modified outside of StatDef's (e.g. StatPart's and StatWorker's))
Line 10: Line 10:
 
| Stat Maximum = {{{max value|}}}<!-- Default = 9999999f -->
 
| Stat Maximum = {{{max value|}}}<!-- Default = 9999999f -->
 
| Stat Minimum = {{{min value|}}}<!-- Default = -9999999f -->
 
| Stat Minimum = {{{min value|}}}<!-- Default = -9999999f -->
−
| Default Base Value = {{{default base value|1}}}<!-- Default = 1f -->
+
| Default Base Value = {{{default base value|}}}<!-- Default = 1f -->
 
| To String Style = {{{to string style|}}}
 
| To String Style = {{{to string style|}}}
 
| Health Type = Stat
 
| Health Type = Stat
Line 23: Line 23:
 
<!-- Booleans -->
 
<!-- Booleans -->
 
| Always Hide = {{{always hide|}}}
 
| Always Hide = {{{always hide|}}}
−
| Apply Factors If Negative = {{{apply factors if negative|true}}}<!-- Default = true -->
+
| Apply Factors If Negative = {{{apply factors if negative|}}}<!-- Default = true -->
 
| Cacheable = {{{cacheable|}}}
 
| Cacheable = {{{cacheable|}}}
 
| Display Max When Above Or Equal = {{{display max when above or equal|}}}
 
| Display Max When Above Or Equal = {{{display max when above or equal|}}}
−
| Finalize Equipped Stat Offset = {{{finalize equipped stat offset|true}}}<!-- Default = true -->
+
| Finalize Equipped Stat Offset = {{{finalize equipped stat offset|}}}<!-- Default = true -->
 
| For Information Only = {{{for information only|}}}
 
| For Information Only = {{{for information only|}}}
 
| Hide In Classic Mode = {{{hide in classic mode|}}}
 
| Hide In Classic Mode = {{{hide in classic mode|}}}
Line 34: Line 34:
 
| Round Value = {{{round value|}}}
 
| Round Value = {{{round value|}}}
 
| Scenario Randomizable = {{{scenario randomizable|}}}
 
| Scenario Randomizable = {{{scenario randomizable|}}}
−
| Show If Undefined = {{{show if undefined|true}}}<!-- Default = true -->
+
| Show If Undefined = {{{show if undefined|}}}<!-- Default = true -->
−
| Show Non Abstract = {{{show non abstract|true}}}<!-- Default = true -->
+
| Show Non Abstract = {{{show non abstract|}}}<!-- Default = true -->
−
| Show On Animals = {{{show on animals|true}}}<!-- Default = true -->
+
| Show On Animals = {{{show on animals|}}}<!-- Default = true -->
−
| Show On Default Value = {{{show on default value|true}}}<!-- Default = true -->
+
| Show On Default Value = {{{show on default value|}}}<!-- Default = true -->
−
| Show On Entities = {{{show on entities|true}}}<!-- Default = true -->
+
| Show On Entities = {{{show on entities|}}}<!-- Default = true -->
−
| Show On Humanlikes = {{{show on humanlikes|true}}}<!-- Default = true -->
+
| Show On Humanlikes = {{{show on humanlikes|}}}<!-- Default = true -->
−
| Show On Mechanoids = {{{show on mechanoids|true}}}<!-- Default = true -->
+
| Show On Mechanoids = {{{show on mechanoids|}}}<!-- Default = true -->
−
| Show On Non Power Plants = {{{show on non power plants|true}}}<!-- Default = true -->
+
| Show On Non Power Plants = {{{show on non power plants|}}}<!-- Default = true -->
−
| Show On Non Wild Man Humanlikes = {{{show on non wild man humanlikes|true}}}<!-- Default = true -->
+
| Show On Non Wild Man Humanlikes = {{{show on non wild man humanlikes|}}}<!-- Default = true -->
−
| Show On Non Work Tables = {{{show on non work tables|true}}}<!-- Default = true -->
+
| Show On Non Work Tables = {{{show on non work tables|}}}<!-- Default = true -->
−
| Show On Pawns = {{{show on pawns|true}}}<!-- Default = true -->
+
| Show On Pawns = {{{show on pawns|}}}<!-- Default = true -->
 
| Show On Player Mechanoids = {{{show on player mechanoids|}}}
 
| Show On Player Mechanoids = {{{show on player mechanoids|}}}
 
| Show On Slaves Only = {{{show on slaves only|}}}
 
| Show On Slaves Only = {{{show on slaves only|}}}
−
| Show On Unhaulables = {{{show on unhaulables|true}}}<!-- Default = true -->
+
| Show On Unhaulables = {{{show on unhaulables|}}}<!-- Default = true -->
−
| Show On Untradeables = {{{show on untradeables|true}}}<!-- Default = true -->
+
| Show On Untradeables = {{{show on untradeables|}}}<!-- Default = true -->
 
| Show Zero Base Value = {{{show zero base value|}}}
 
| Show Zero Base Value = {{{show zero base value|}}}
 
| Suppress Disabled Error = {{{suppress disabled error|}}}<!-- written in code as: supressDisabledError -->
 
| Suppress Disabled Error = {{{suppress disabled error|}}}<!-- written in code as: supressDisabledError -->
Line 57: Line 57:
 
<!--| Max Value = {{{max value|9999999}}}--><!-- Default = 9999999f -->
 
<!--| Max Value = {{{max value|9999999}}}--><!-- Default = 9999999f -->
 
<!--| Min Value = {{{min value|-9999999}}}--><!-- Default = -9999999f -->
 
<!--| Min Value = {{{min value|-9999999}}}--><!-- Default = -9999999f -->
−
| No Skill Factor = {{{no skill factor|1}}}<!-- Default = 1f -->
+
| No Skill Factor = {{{no skill factor|}}}<!-- Default = 1f -->
 
| No Skill Offset = {{{no skill offset|}}}
 
| No Skill Offset = {{{no skill offset|}}}
−
| Round To Five Over = {{{round to five over|{{#if:{{P|Stat Maximum}}|{{P|Stat Maximum}} }} }}}<!-- Default = float.MaxValue -->
+
| Round To Five Over = {{{round to five over|}}}<!-- Default = float.MaxValue --><!-- {{#if:{{P|Stat Maximum}}|{{P|Stat Maximum}} }} -->
 
| Value If Missing = {{{value if missing|}}}
 
| Value If Missing = {{{value if missing|}}}
 
<!-- Lists -->
 
<!-- Lists -->
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|}}}<!-- Default = DevelopmentalStage.Baby | DevelopmentalStage.Child | DevelopmentalStage.Adult --><!--DevelopmentalStage--><!-- Baby, Child, Adult -->
 
| 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-->
 
<!--| Category = {{{category|}}}--><!--StatCategoryDef-->
 
<!--| Category = {{{category|}}}--><!--StatCategoryDef-->
−
| To String Number Sense = {{{to string number sense|Absolute}}}<!-- Default = ToStringNumberSense.Absolute --><!--ToStringNumberSense-->
+
| To String Number Sense = {{{to string number sense|}}}<!-- Default = ToStringNumberSense.Absolute --><!--ToStringNumberSense--><!-- Absolute -->
 
<!--| To String Style = {{{to string style|}}}--><!--ToStringStyle-->
 
<!--| To String Style = {{{to string style|}}}--><!--ToStringStyle-->
 
| Worker Class = {{{worker class|}}}<!-- Default = typeof(StatWorker) --><!--Type-->
 
| Worker Class = {{{worker class|}}}<!-- Default = typeof(StatWorker) --><!--Type-->

Revision as of 15:51, 23 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

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 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.
Retrieved from "https://rimworldwiki.com/index.php?title=Template:Stat&oldid=154774"