Difference between revisions of "Template:Gear List/doc"
m |
m (usage of the format by itself and with the template, also included tables of apparel, weapons, and tech) |
||
| Line 5: | Line 5: | ||
Currently this formatting template is planned to be moved to a subpage, where this main page will instead hold an #ask query based template, not unlike [[Template:Tag List]], with a output format like [[Template:Icon List]]. | Currently this formatting template is planned to be moved to a subpage, where this main page will instead hold an #ask query based template, not unlike [[Template:Tag List]], with a output format like [[Template:Icon List]]. | ||
| + | |||
| + | Example of just using the subpage template formatting: | ||
<nowiki>{{#ask: [[WeaponTags::ShortShots||Neolithic]] | <nowiki>{{#ask: [[WeaponTags::ShortShots||Neolithic]] | ||
| Line 24: | Line 26: | ||
| sep = ,<br /> | | sep = ,<br /> | ||
}} | }} | ||
| + | |||
| + | Example of using the combined formatting and template: | ||
| + | |||
| + | <nowiki>{{Gear List|WeaponTags|ShortShots|Neolithic}}</nowiki> | ||
| + | {{Gear List|WeaponTags|ShortShots|Neolithic}} | ||
An item budget can be applied to this query via an acceptable market value range, although for applicable items, quality and stuff would need to be factored in per item or otherwise ignored. | An item budget can be applied to this query via an acceptable market value range, although for applicable items, quality and stuff would need to be factored in per item or otherwise ignored. | ||
| Line 123: | Line 130: | ||
=== Apparel === | === Apparel === | ||
| − | Apparel may have quality and/or stuffability. | + | Apparel may have quality and/or stuffability. A lot of Pawn Kinds will have Required, Disallowed, or otherwise incompatible apparel items, based on a mix of factors like [[Property:Layer|Layer]], [[Property:Coverage|Coverage]], and [[Property:Tags|Tags]]. This means that a lot of additional filters must be put into place in the #ask query, making the combined template less practical. |
| + | |||
| + | {{#ask:[[Tags::+]] | ||
| + | | ?Market Value Base# = Approx. Value | ||
| + | | ?Has Quality | ||
| + | | ?Stuff Tags | ||
| + | | format = table | ||
| + | | sort = Market Value Base | ||
| + | | limit = 100 | ||
| + | }} | ||
=== Weapons === | === Weapons === | ||
| − | Weapons may have quality and/or stuffability. | + | Weapons may have quality and/or stuffability. Most Pawn Kinds do not have any sort of Required or Disallowed weapons, using [[Property:WeaponTags|WeaponTags]] primarily to define available weapons, which makes it rather practical to use the combined template. |
| + | |||
| + | {{#ask:[[WeaponTags::+]] | ||
| + | | ?Market Value Base# = Approx. Value | ||
| + | | ?Has Quality | ||
| + | | ?Stuff Tags | ||
| + | | format = table | ||
| + | | sort = Market Value Base | ||
| + | | limit = 100 | ||
| + | }} | ||
=== Tech / Hediffs === | === Tech / Hediffs === | ||
| − | Tech hediffs do not have quality or stuffability, resulting in each piece of tech having a singular consistent market value. | + | Tech hediffs do not have quality or stuffability, resulting in each piece of tech having a singular consistent market value. This means there are no problems in using the combined template, aside from no current handling for tech hediffs with no market value, which is easily fixable. |
| + | |||
| + | {{#ask:[[TechHediffsTags::+]] | ||
| + | | ?Market Value Base# = Market Value | ||
| + | | format = table | ||
| + | | sort = Market Value Base | ||
| + | | limit = 100 | ||
| + | }} | ||
<noinclude>[[Category:Template documentation]]</noinclude> | <noinclude>[[Category:Template documentation]]</noinclude> | ||
<includeonly>[[Category:Templates]]</includeonly> | <includeonly>[[Category:Templates]]</includeonly> | ||
Revision as of 05:52, 17 August 2024
Overview
Planned to be used for pawn kind tables: for displaying the available apparel, weapons, and tech hediffs based on tags, budget, and other encompassing factors. The current design uses a template to format the output from an #ask query, as a list consisting of an icon, text link, and applicable DLC icon for each item (Having the ability to hide DLC icons based on the categories of the page the template is used on would be nice. We don't need 300 little Royalty icons within the Empire pawn kinds table now do we?).
Currently this formatting template is planned to be moved to a subpage, where this main page will instead hold an #ask query based template, not unlike Template:Tag List, with a output format like Template:Icon List.
Example of just using the subpage template formatting:
{{#ask: [[WeaponTags::ShortShots||Neolithic]]
| format = template
| template = Gear List/Items
| link = none
| default = None
| limit = 10
| sort = Layer,Tags,Market Value Base,WeaponTags,TechHediffsTags,From DLC
| sep = ,<br />
}}
Short bow,
Flamebow 
,
Recurve bow,
Greatbow,
Pila,
Machine pistol,
Pump shotgun,
Heavy SMG,
Chain shotgun
Example of using the combined formatting and template:
{{Gear List|WeaponTags|ShortShots|Neolithic}}
Short bow, Flamebow , Recurve bow, Greatbow, Pila, Machine pistol, Pump shotgun, Heavy SMG, Chain shotgun
An item budget can be applied to this query via an acceptable market value range, although for applicable items, quality and stuff would need to be factored in per item or otherwise ignored.
If item quality and applicable stuff is factored in, then this combined with the budget range for one or more items, and a variable amount of item tags, wouldn't allow for an easy to implement template. Tech hediffs remain the simplest in having only one associated market value per item, allowing for a proper application of budget.
{{#ask: [[TechHediffsTags::Simple||Advanced]]
| format = template
| template = Gear List/Items
| link = none
| sort = TechHediffsTags, From DLC
| sep = ,
}}
Bionic stomach, 
Power claw, Bionic eye, Bionic leg, Bionic spine, Bionic tongue, Bionic ear, Joywire, Bionic arm, Bionic jaw, Bionic heart, Painstopper, Detoxifier kidney , Detoxifier lung , Immunoenhancer 
, Circadian assistant , Sterilizing stomach , Reprocessor stomach , Learning assistant , Circadian half-cycler , Toughskin gland , Love enhancer , Coagulator , Stoneskin gland , Neurocalculator , Gastro-analyzer , Aesthetic nose , Armorskin gland , Nuclear stomach , Healing enhancer , Aesthetic shaper , Prosthetic arm, Prosthetic heart, Prosthetic leg, Cochlear implant
{{#ask: [[TechHediffsTags::Simple||Advanced]] [[Market Value Base ::<700]]
| format = template
| template = Gear List/Items
| link = none
| sort = TechHediffsTags, From DLC
| sep = ,
}}
Bionic tongue, Joywire, Power claw, Painstopper, Aesthetic nose , Cochlear implant, Prosthetic arm, Prosthetic heart, Prosthetic leg
Demonstration that tech tags and market value are properly interpreted:
{{#ask: [[TechHediffsTags::Simple||Advanced]]
| ?TechHediffsTags# = tags
| ?Market Value Base# = value
| format = list
| sort = TechHediffsTags, From DLC
| sep = ,
}}
Bionic stomach (tags: Advanced, value: 785), Power claw (tags: Advanced, AdvancedWeapon, value: 385), Bionic eye (tags: Advanced, value: 1030), Bionic leg (tags: Advanced, value: 1030), Bionic spine (tags: Advanced, value: 1030), Bionic tongue (tags: Advanced, value: 565), Bionic ear (tags: Advanced, value: 785), Joywire (tags: Advanced, value: 220), Bionic arm (tags: Advanced, value: 1030), Bionic jaw (tags: Advanced, value: 1030), Bionic heart (tags: Advanced, value: 1030), Painstopper (tags: Advanced, value: 220), Detoxifier kidney (tags: Advanced, value: 1080), Detoxifier lung (tags: Advanced, value: 925), Immunoenhancer (tags: Advanced, ImplantEmpireCommon, value: 1030), Circadian assistant (tags: Advanced, ImplantEmpireCommon, value: 1030), Sterilizing stomach (tags: Advanced, ImplantEmpireCommon, value: 1030), Reprocessor stomach (tags: Advanced, ImplantEmpireCommon, value: 1030), Learning assistant (tags: Advanced, ImplantEmpireCommon, value: 1030), Circadian half-cycler (tags: Advanced, ImplantEmpireCommon, value: 1030), Toughskin gland (tags: Advanced, ImplantEmpireCommon, value: 1030), Love enhancer (tags: Advanced, ImplantEmpireCommon, value: 1030), Coagulator (tags: Advanced, ImplantEmpireCommon, value: 830), Stoneskin gland (tags: Advanced, ImplantEmpireCommon, value: 1920), Neurocalculator (tags: Advanced, ImplantEmpireCommon, value: 1030), Gastro-analyzer (tags: Advanced, ImplantEmpireCommon, value: 830), Aesthetic nose (tags: Advanced, ImplantEmpireCommon, value: 585), Armorskin gland (tags: Advanced, ImplantEmpireCommon, value: 1475), Nuclear stomach (tags: Advanced, ImplantEmpireCommon, value: 1030), Healing enhancer (tags: Advanced, ImplantEmpireCommon, value: 1030), Aesthetic shaper (tags: Advanced, ImplantEmpireCommon, value: 830), Prosthetic arm (tags: Simple, value: 260), Prosthetic heart (tags: Simple, value: 230), Prosthetic leg (tags: Simple, value: 260), Cochlear implant (tags: Simple, value: 220)
{{#ask: [[TechHediffsTags::Simple||Advanced]] [[Market Value Base ::<700]]
| ?TechHediffsTags# = tags
| ?Market Value Base# = value
| format = list
| sort = TechHediffsTags, From DLC
| sep = ,
}}
Bionic tongue (tags: Advanced, value: 565), Joywire (tags: Advanced, value: 220), Power claw (tags: Advanced, AdvancedWeapon, value: 385), Painstopper (tags: Advanced, value: 220), Aesthetic nose (tags: Advanced, ImplantEmpireCommon, value: 585), Cochlear implant (tags: Simple, value: 220), Prosthetic arm (tags: Simple, value: 260), Prosthetic heart (tags: Simple, value: 230), Prosthetic leg (tags: Simple, value: 260)
Budget
Budget applies to the 3 main tag categories, and is a variable range in total market value available to a pawn to 'spend' for applicable items. It does not mean that the market value of an item or items must be above the minimum of this range, just that the sum value of the chosen item(s) isn't over the maximum (i.e. spending over the budget).
Tech hediffs all have a fixed market value, or none at all (e.g. Denture), and so allow for the easiest calculation. By default, only 1 available tech hediff can be applied to the pawn unless explicitly stated.
Apparel value can depend on quality and stuffable material used, meaning the range for possible outcomes is too large for many textile based clothing, but remains simpler for most armors. All utility items are not stuffable, and most do not have quality, so they remain much less variable, although most utility items will be forced and thus remain a static cost[verify], aside from the few utility items that can have quality (Shield belt, Jump pack). Pawns are highly likely to be wearing multiple articles of clothing, and so calculating all possible outcomes is not viable.
Most weapons are not stuffable, and those that are have a much more limited item pool compared to clothing. Ranged weapons are not stuffable and only depend on quality for price, while most craftable melee weapons are stuffable. The Club doesn't use quality, but remains stuffable. Pawns are only equipped with one weapon, so this budget will only apply to one final item.
Quality
By default, the item quality of any given pawn kind is capped at excellent quality, excluding masterwork and legendary, allowing for a range of: awful, poor, normal, good, and excellent (awfl - exc), unless otherwise stated. For our purposes, quality would only apply to most apparel and weapons, excluding any kind of hediff.
For reference, here are the full length and shorthand strings for quality categories:
- awful
- awfl
- poor
- poor
- normal
- norm
- good
- good
- excellent
- exc
- masterwork
- mast
- legendary
- legd
Stuff
Applicable for certain weapons and apparel.
Apparel
Apparel may have quality and/or stuffability. A lot of Pawn Kinds will have Required, Disallowed, or otherwise incompatible apparel items, based on a mix of factors like Layer, Coverage, and Tags. This means that a lot of additional filters must be put into place in the #ask query, making the combined template less practical.
Weapons
Weapons may have quality and/or stuffability. Most Pawn Kinds do not have any sort of Required or Disallowed weapons, using WeaponTags primarily to define available weapons, which makes it rather practical to use the combined template.
Tech / Hediffs
Tech hediffs do not have quality or stuffability, resulting in each piece of tech having a singular consistent market value. This means there are no problems in using the combined template, aside from no current handling for tech hediffs with no market value, which is easily fixable.