Difference between revisions of "Template:Stat"

From RimWorld Wiki
Jump to navigation Jump to search
m (No real point in having an such an obscure default value)
m (Better code readability, Fixed default value for "Round To Five Over" (hopefully), and added default values for "Default Base Value" (1) and "Show Developmental Stage Filter" (Baby, Child, Adult))
Line 8: Line 8:
 
| Def Name = {{{def name|}}}
 
| Def Name = {{{def name|}}}
 
| Label = {{{label|}}}
 
| Label = {{{label|}}}
−
| Stat Maximum = {{{max value|}}}<!-- 9999999 -->
+
| Stat Maximum = {{{max value|}}}<!-- Default = 9999999f -->
−
| Stat Minimum = {{{min value|}}}<!-- -9999999 -->
+
| Stat Minimum = {{{min value|}}}<!-- Default = -9999999f -->
−
| Default Base Value = {{{default base value|}}}<!-- 1 -->
+
| Default Base Value = {{{default base value|1}}}<!-- 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}}}
+
| Apply Factors If Negative = {{{apply factors if negative|true}}}<!-- 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}}}
+
| Finalize Equipped Stat Offset = {{{finalize equipped stat offset|true}}}<!-- 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}}}
+
| Show If Undefined = {{{show if undefined|true}}}<!-- Default = true -->
−
| Show Non Abstract = {{{show non abstract|true}}}
+
| Show Non Abstract = {{{show non abstract|true}}}<!-- Default = true -->
−
| Show On Animals = {{{show on animals|true}}}
+
| Show On Animals = {{{show on animals|true}}}<!-- Default = true -->
−
| Show On Default Value = {{{show on default value|true}}}
+
| Show On Default Value = {{{show on default value|true}}}<!-- Default = true -->
−
| Show On Entities = {{{show on entities|true}}}
+
| Show On Entities = {{{show on entities|true}}}<!-- Default = true -->
−
| Show On Humanlikes = {{{show on humanlikes|true}}}
+
| Show On Humanlikes = {{{show on humanlikes|true}}}<!-- Default = true -->
−
| Show On Mechanoids = {{{show on mechanoids|true}}}
+
| Show On Mechanoids = {{{show on mechanoids|true}}}<!-- Default = true -->
−
| Show On Non Power Plants = {{{show on non power plants|true}}}
+
| Show On Non Power Plants = {{{show on non power plants|true}}}<!-- Default = true -->
−
| Show On Non Wild Man Humanlikes = {{{show on non wild man humanlikes|true}}}
+
| Show On Non Wild Man Humanlikes = {{{show on non wild man humanlikes|true}}}<!-- Default = true -->
−
| Show On Non Work Tables = {{{show on non work tables|true}}}
+
| Show On Non Work Tables = {{{show on non work tables|true}}}<!-- Default = true -->
−
| Show On Pawns = {{{show on pawns|true}}}
+
| Show On Pawns = {{{show on pawns|true}}}<!-- 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}}}
+
| Show On Unhaulables = {{{show on unhaulables|true}}}<!-- Default = true -->
−
| Show On Untradeables = {{{show on untradeables|true}}}
+
| Show On Untradeables = {{{show on untradeables|true}}}<!-- 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 -->
 
| Immutable = {{{immutable|}}}
 
| Immutable = {{{immutable|}}}
 
<!-- Floats -->
 
<!-- Floats -->
−
<!--| Default Base Value = {{{default base value|1}}}-->
+
<!--| Default Base Value = {{{default base value|1}}}--><!-- Default = 1f -->
−
| Hide At Value = {{{hide at value|}}}
+
| Hide At Value = {{{hide at value|}}}<!-- Default = -2.14748365E+09f -->
−
<!--| Max Value = {{{max value|9999999}}}-->
+
<!--| Max Value = {{{max value|9999999}}}--><!-- Default = 9999999f -->
−
<!--| Min Value = {{{min value|-9999999}}}-->
+
<!--| Min Value = {{{min value|-9999999}}}--><!-- Default = -9999999f -->
−
| No Skill Factor = {{{no skill factor|1}}}
+
| No Skill Factor = {{{no skill factor|1}}}<!-- Default = 1f -->
 
| No Skill Offset = {{{no skill offset|}}}
 
| No Skill Offset = {{{no skill offset|}}}
−
| Round To Five Over = {{{round to five over|{{#if: Stat Maximum}} }}}
+
| Round To Five Over = {{{round to five over|{{#if: Stat Maximum|{{{P|Stat Maximum}}} }} }}}<!-- Default = float.MaxValue -->
 
| Value If Missing = {{{value if missing|}}}
 
| Value If Missing = {{{value if missing|}}}
 
<!-- Lists -->
 
<!-- Lists -->
−
<!--List<HediffDef>-->  | Show If Hediffs Present = {{{show if hediffs present|}}}
+
| Show If Hediffs Present = {{{show if hediffs present|}}}<!--List<HediffDef>-->
−
<!--List<PawnCapacityFactor>--> | Capacity Factors = {{{capacity factors|}}}
+
| Capacity Factors = {{{capacity factors|}}}<!--List<PawnCapacityFactor>-->
−
<!--List<PawnCapacityOffset>--> | Capacity Offsets = {{{capacity offsets|}}}
+
| Capacity Offsets = {{{capacity offsets|}}}<!--List<PawnCapacityOffset>-->
−
<!--List<PawnKindDef>-->| Show On Pawn Kind = {{{show on pawn kind|}}}
+
| Show On Pawn Kind = {{{show on pawn kind|}}}<!--List<PawnKindDef>-->
−
<!--List<SkillNeed>--> | Skill Need Factors = {{{skill need factors|}}}
+
| Skill Need Factors = {{{skill need factors|}}}<!--List<SkillNeed>-->
−
<!--List<SkillNeed>--> | Skill Need Offsets = {{{skill need offsets|}}}
+
| Skill Need Offsets = {{{skill need offsets|}}}<!--List<SkillNeed>-->
−
<!--List<StatDef>-->| Post Process Stat Factors = {{{post process stat factors|}}}
+
| Post Process Stat Factors = {{{post process stat factors|}}}<!--List<StatDef>-->
−
<!--List<StatDef>-->| Stat Factors = {{{stat factors|}}}
+
| Stat Factors = {{{stat factors|}}}<!--List<StatDef>-->
−
<!--List<StatPart>-->   | Parts = {{{parts|}}}
+
| Parts = {{{parts|}}}<!--List<StatPart>-->
−
<!--List<String>--> | Show If Mods Loaded = {{{show if mods loaded|}}}
+
| Show If Mods Loaded = {{{show if mods loaded|}}}<!--List<String>-->
−
<!--List<String>--> | Show If Mods Loaded Any = {{{show if mods loaded any|}}}
+
| Show If Mods Loaded Any = {{{show if mods loaded any|}}}<!--List<String>-->
 
<!-- Integer -->
 
<!-- Integer -->
−
| Display Priority In Category = {{{display priority in category|}}}
+
| Display Priority In Category = {{{display priority in category|}}}
 
<!-- Other -->
 
<!-- Other -->
−
<!--StatWorker-->  | Worker Int = {{{worker int|}}}
+
| Worker Int = {{{worker int|}}}<!--StatWorker-->
−
<!--ToStringStyle?-->   | To String Style Unfinalized = {{{to string style unfinalized|}}}
+
| To String Style Unfinalized = {{{to string style unfinalized|}}}<!--ToStringStyle?-->
−
<!--Hashset<StatDef>--> | Mutable Stats = {{{mutable stats|}}}
+
| Mutable Stats = {{{mutable stats|}}}<!--Hashset<StatDef>-->
−
<!--DevelopmentalStage-->   | Show Developmental Stage Filter = {{{show developmental stage filter|}}}<!-- Baby, Child, Adult -->
+
| Show Developmental Stage Filter = {{{show developmental stage filter|Baby, Child, Adult}}}<!-- Default = DevelopmentalStage.Baby | DevelopmentalStage.Child | DevelopmentalStage.Adult --><!--DevelopmentalStage-->
−
<!--SimpleCurve--> | Post Process Curve = {{{post process curve|}}}
+
| Post Process Curve = {{{post process curve|}}}<!--SimpleCurve-->
−
<!--SkillDef--> | Disable If Skill Disabled = {{{disable if skill disabled|}}}
+
| Disable If Skill Disabled = {{{disable if skill disabled|}}}<!--SkillDef-->
−
<!--StatCategoryDef--><!-- | Category = {{{category|}}}-->
+
<!--| Category = {{{category|}}}--><!--StatCategoryDef-->
−
<!--ToStringNumberSense--> | To String Number Sense = {{{to string number sense|Absolute}}}
+
| To String Number Sense = {{{to string number sense|Absolute}}}<!-- Default = ToStringNumberSense.Absolute --><!--ToStringNumberSense-->
−
<!--ToStringStyle--><!--| To String Style = {{{to string style|}}}-->
+
<!--| To String Style = {{{to string style|}}}--><!--ToStringStyle-->
−
<!--Type--> | Worker Class = {{{worker class|}}}
+
| Worker Class = {{{worker class|}}}<!-- Default = typeof(StatWorker) --><!--Type-->
 
   }}
 
   }}
 +
  {{#if:{{{P|Always Hide}}}|[[Category:Stats - Always Hide]]}}
 +
  {{#if:{{{P|For Information Only}}}|[[Category:Stats - For Information Only]]}}
 
   [[Category:{{#switch: {{{category|}}}
 
   [[Category:{{#switch: {{{category|}}}
 
| Important
 
| Important
 
| Basics Important
 
| Basics Important
−
| BasicsImportant = Stats - Important
+
| BasicsImportant = Stats - Important
 
| Pawn Important
 
| Pawn Important
 
| Basics Pawn Important
 
| Basics Pawn Important
−
| BasicsPawnImportant = Stats - Pawn Important
+
| BasicsPawnImportant = Stats - Pawn Important
 
| NonPawnImportant
 
| NonPawnImportant
 
| Basics Non Pawn Important
 
| Basics Non Pawn Important
−
| BasicsNonPawnImportant = Stats - Non Pawn Important
+
| BasicsNonPawnImportant = Stats - Non Pawn Important
−
| Basics   = Stats - Basics
+
| Basics = Stats - Basics
 
| Pawn
 
| Pawn
−
| BasicsPawn   = Stats - Pawn
+
| BasicsPawn = Stats - Pawn
 
| Non Pawn
 
| Non Pawn
 
| NonPawn
 
| NonPawn
−
| BasicsNonPawn = Stats - Non Pawn
+
| BasicsNonPawn = Stats - Non Pawn
−
| Terrain   = Stats - Terrain
+
| Terrain = Stats - Terrain
−
| Meditation   = Stats - Meditation
+
| Meditation = Stats - Meditation
−
| Mechanoid = Stats - Mechanoid
+
| Mechanoid = Stats - Mechanoid
−
| Apparel   = Stats - Apparel
+
| Apparel = Stats - Apparel
 
| Buildings
 
| Buildings
−
| Building = Stats - Building
+
| Building = Stats - Building
 
| Ranged Weapon
 
| Ranged Weapon
 
| Ranged
 
| Ranged
−
| Weapon_Ranged = Stats - Weapon (Ranged)
+
| Weapon_Ranged = Stats - Weapon (Ranged)
 
| Melee
 
| Melee
 
| Melee Weapon
 
| Melee Weapon
−
| Weapon_Melee = Stats - Weapon (Melee)
+
| Weapon_Melee = Stats - Weapon (Melee)
−
| Ability   = Stats - Ability
+
| Ability = Stats - Ability
 
| Stuff Stat Factors
 
| Stuff Stat Factors
−
| StuffStatFactors = Stats - Stuff Stat Factors
+
| StuffStatFactors = Stats - Stuff Stat Factors
−
| Mechanitor   = Stats - Mechanitor
+
| Mechanitor = Stats - Mechanitor
 
| Pawn Combat
 
| Pawn Combat
−
| PawnCombat   = Stats - Pawn Combat
+
| PawnCombat = Stats - Pawn Combat
 
| Social
 
| Social
 
| Pawn Social
 
| Pawn Social
−
| PawnSocial   = Stats - Pawn Social
+
| PawnSocial = Stats - Pawn Social
 
| Misc
 
| Misc
 
| Pawn Misc
 
| Pawn Misc
−
| PawnMisc = Stats - Pawn Misc
+
| PawnMisc = Stats - Pawn Misc
 
| Work
 
| Work
 
| Pawn Work
 
| Pawn Work
−
| PawnWork = Stats - Pawn Work
+
| PawnWork = Stats - Pawn Work
 
| Psychic Ritual
 
| Psychic Ritual
−
| PsychicRituals   = Stats - Psychic Ritual
+
| PsychicRituals = Stats - Psychic Ritual
−
| Containment   = Stats - Containment
+
| Containment = Stats - Containment
−
| Obsolete = Stats - Obsolete
+
| Obsolete = Stats - Obsolete
−
| #default = Stat}}]]
+
| #default = Stat}}]]
 
}}<!--
 
}}<!--
  

Revision as of 20:20, 22 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

No Table (Default)

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

Table

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

Retrieved from "https://rimworldwiki.com/index.php?title=Template:Stat&oldid=151442"