Difference between revisions of "Template:Stat"
Jump to navigation
Jump to search
m (Additional parameters) |
m (Nullified "Show Developmental Stage Filter" Default Value to remove some clutter, at least until all Stats have this property filled out) |
||
(9 intermediate revisions by the same user not shown) | |||
Line 8: | Line 8: | ||
| Def Name = {{{def name|}}} | | Def Name = {{{def name|}}} | ||
| Label = {{{label|}}} | | Label = {{{label|}}} | ||
− | | Stat Maximum = {{{max value|}}}<!-- | + | | Stat Maximum = {{{max value|}}}<!-- Default = 9999999f --> |
− | | Stat Minimum = {{{min value|}}}<!-- - | + | | Stat Minimum = {{{min value|}}}<!-- Default = -9999999f --> |
− | | Default Base Value = {{{default base value|}}}<!-- | + | | 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 16: | Line 16: | ||
| Effective Maximum = {{#expr: {{{effective maximum|}}} }} | | Effective Maximum = {{#expr: {{{effective maximum|}}} }} | ||
<!-- Strings --> | <!-- Strings --> | ||
− | | Offset Label = {{offset label|}} | + | | Offset Label = {{{offset label|}}} |
− | | Format String = {{format string|}} | + | | Format String = {{{format string|}}} |
− | | Format String Unfinalized = {{format string unfinalized|}} | + | | Format String Unfinalized = {{{format string unfinalized|}}} |
− | | Stat Factors Explanation Header = {{stat factors explanation header|}} | + | | Stat Factors Explanation Header = {{{stat factors explanation header|}}} |
− | | Label For Full Stat List = {{label for full stat list|}} | + | | Label For Full Stat List = {{{label for full stat list|}}} |
<!-- Booleans --> | <!-- Booleans --> | ||
− | | Always Hide = {{always hide|}} | + | | Always Hide = {{{always hide|}}} |
− | | For Information Only = {{for information only|}} | + | | Apply Factors If Negative = {{{apply factors if negative|true}}}<!-- Default = true --> |
− | | Show On Animals = {{show on animals|true}} | + | | Cacheable = {{{cacheable|}}} |
− | | Show On Default Value = {{show on default value|true}} | + | | Display Max When Above Or Equal = {{{display max when above or equal|}}} |
− | | Show On Entities = {{show on entities|true}} | + | | Finalize Equipped Stat Offset = {{{finalize equipped stat offset|true}}}<!-- Default = true --> |
− | | Show On Humanlikes = {{show on humanlikes|true}} | + | | For Information Only = {{{for information only|}}} |
− | | Show On Mechanoids = {{show on mechanoids|true}} | + | | Hide In Classic Mode = {{{hide in classic mode|}}} |
− | | Show On Non Power Plants = {{show on non power plants|true}} | + | | Minified Thing Inherits = {{{minified thing inherits|}}} |
− | | Show On Non Wild Man Humanlikes = {{show on non wild man humanlikes|true}} | + | | Never Disabled = {{{never disabled|}}} |
− | | Show On Non Work Tables = {{show on non work tables|true}} | + | | Overrides Hide Stats = {{{overrides hide stats|}}} |
− | | Show On Pawns = {{show on pawns|true}} | + | | Round Value = {{{round value|}}} |
− | | Show On Player Mechanoids = {{show on player mechanoids|}} | + | | Scenario Randomizable = {{{scenario randomizable|}}} |
− | | Show On Slaves Only = {{show on slaves only|}} | + | | Show If Undefined = {{{show if undefined|true}}}<!-- Default = true --> |
− | | Show On Unhaulables = {{show on unhaulables|true}} | + | | Show Non Abstract = {{{show non abstract|true}}}<!-- Default = true --> |
− | | Show On Untradeables = {{show on untradeables|true}} | + | | Show On Animals = {{{show on animals|true}}}<!-- Default = true --> |
− | | Show Zero Base Value = {{show zero base value|}} | + | | Show On Default Value = {{{show on default value|true}}}<!-- Default = true --> |
− | | Display Priority In Category = {{display priority in category|}} | + | | Show On Entities = {{{show on entities|true}}}<!-- Default = true --> |
− | + | | Show On Humanlikes = {{{show on humanlikes|true}}}<!-- Default = true --> | |
− | | Worker Class = {{worker class|}} | + | | Show On Mechanoids = {{{show on mechanoids|true}}}<!-- Default = 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}}}<!-- Default = true --> | ||
+ | | Show On Non Work Tables = {{{show on non work tables|true}}}<!-- Default = true --> | ||
+ | | Show On Pawns = {{{show on pawns|true}}}<!-- Default = true --> | ||
+ | | Show On Player Mechanoids = {{{show on player mechanoids|}}} | ||
+ | | Show On Slaves Only = {{{show on slaves only|}}} | ||
+ | | Show On Unhaulables = {{{show on unhaulables|true}}}<!-- Default = true --> | ||
+ | | Show On Untradeables = {{{show on untradeables|true}}}<!-- Default = true --> | ||
+ | | Show Zero Base Value = {{{show zero base value|}}} | ||
+ | | Suppress Disabled Error = {{{suppress disabled error|}}}<!-- written in code as: supressDisabledError --> | ||
+ | | Immutable = {{{immutable|}}} | ||
+ | <!-- Floats --> | ||
+ | <!--| Default Base Value = {{{default base value|1}}}--><!-- Default = 1f --> | ||
+ | | Hide At Value = {{{hide at value|}}}<!-- Default = -2.14748365E+09f --> | ||
+ | <!--| Max Value = {{{max value|9999999}}}--><!-- Default = 9999999f --> | ||
+ | <!--| Min Value = {{{min value|-9999999}}}--><!-- Default = -9999999f --> | ||
+ | | No Skill Factor = {{{no skill factor|1}}}<!-- Default = 1f --> | ||
+ | | No Skill Offset = {{{no skill offset|}}} | ||
+ | | Round To Five Over = {{{round to five over|{{#if:{{P|Stat Maximum}}|{{P|Stat Maximum}} }} }}}<!-- Default = float.MaxValue --> | ||
+ | | Value If Missing = {{{value if missing|}}} | ||
+ | <!-- Lists --> | ||
+ | | Show If Hediffs Present = {{{show if hediffs present|}}}<!--List<HediffDef>--> | ||
+ | | Capacity Factors = {{{capacity factors|}}}<!--List<PawnCapacityFactor>--> | ||
+ | | Capacity Offsets = {{{capacity offsets|}}}<!--List<PawnCapacityOffset>--> | ||
+ | | Show On Pawn Kind = {{{show on pawn kind|}}}<!--List<PawnKindDef>--> | ||
+ | | Skill Need Factors = {{{skill need factors|}}}<!--List<SkillNeed>--> | ||
+ | | Skill Need Offsets = {{{skill need offsets|}}}<!--List<SkillNeed>--> | ||
+ | | Post Process Stat Factors = {{{post process stat factors|}}}<!--List<StatDef>--> | ||
+ | | Stat Factors = {{{stat factors|}}}<!--List<StatDef>--> | ||
+ | | Parts = {{{parts|}}}<!--List<StatPart>--> | ||
+ | | Show If Mods Loaded = {{{show if mods loaded|}}}<!--List<String>--> | ||
+ | | Show If Mods Loaded Any = {{{show if mods loaded any|}}}<!--List<String>--> | ||
+ | <!-- Integer --> | ||
+ | | Display Priority In Category = {{{display priority in category|}}} | ||
+ | <!-- Other --> | ||
+ | | Worker Int = {{{worker int|}}}<!--StatWorker--> | ||
+ | | To String Style Unfinalized = {{{to string style unfinalized|}}}<!--ToStringStyle?--> | ||
+ | | 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--> | ||
+ | | Post Process Curve = {{{post process curve|}}}<!--SimpleCurve--> | ||
+ | | Disable If Skill Disabled = {{{disable if skill disabled|}}}<!--SkillDef--> | ||
+ | <!--| Category = {{{category|}}}--><!--StatCategoryDef--> | ||
+ | | To String Number Sense = {{{to string number sense|Absolute}}}<!-- Default = ToStringNumberSense.Absolute --><!--ToStringNumberSense--> | ||
+ | <!--| To String Style = {{{to string style|}}}--><!--ToStringStyle--> | ||
+ | | Worker Class = {{{worker class|}}}<!-- Default = typeof(StatWorker) --><!--Type--> | ||
}} | }} | ||
[[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 | + | | Basics = Stats - Basics |
| Pawn | | Pawn | ||
− | | BasicsPawn | + | | BasicsPawn = Stats - Pawn |
| Non Pawn | | Non Pawn | ||
| NonPawn | | NonPawn | ||
− | | BasicsNonPawn = Stats - Non Pawn | + | | BasicsNonPawn = Stats - Non Pawn |
− | | Terrain | + | | Terrain = Stats - Terrain |
− | | Meditation | + | | Meditation = Stats - Meditation |
− | | Mechanoid | + | | Mechanoid = Stats - Mechanoid |
− | | Apparel | + | | Apparel = Stats - Apparel |
| Buildings | | Buildings | ||
− | | 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 | + | | Weapon_Melee = Stats - Weapon (Melee) |
− | | Ability | + | | Ability = Stats - Ability |
| Stuff Stat Factors | | Stuff Stat Factors | ||
− | | StuffStatFactors = Stats - Stuff Stat Factors | + | | StuffStatFactors = Stats - Stuff Stat Factors |
− | | Mechanitor | + | | Mechanitor = Stats - Mechanitor |
| Pawn Combat | | Pawn Combat | ||
− | | PawnCombat | + | | PawnCombat = Stats - Pawn Combat |
| Social | | Social | ||
| Pawn Social | | Pawn Social | ||
− | | PawnSocial | + | | PawnSocial = Stats - Pawn Social |
| Misc | | Misc | ||
| Pawn Misc | | Pawn Misc | ||
− | | PawnMisc | + | | PawnMisc = Stats - Pawn Misc |
| Work | | Work | ||
| Pawn Work | | Pawn Work | ||
− | | PawnWork | + | | PawnWork = Stats - Pawn Work |
| Psychic Ritual | | Psychic Ritual | ||
− | | PsychicRituals | + | | PsychicRituals = Stats - Psychic Ritual |
− | | Containment | + | | Containment = Stats - Containment |
− | | Obsolete | + | | Obsolete = Stats - Obsolete |
− | | #default | + | | #default = Stat}}]] |
}}<!-- | }}<!-- | ||
Latest revision as of 19:16, 23 September 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]
Stat is a stat: Speed at which this person sows and harvests plants. Its minimum allowed value is 10% (effectively limited to 11%). Its maximum allowed value is 100% (effectively limited to 90%). Its default value is 50%.
The above documentation is transcluded from Template:Stat/doc. (edit | history) Editors can experiment in this template's sandbox (edit | diff) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |