Template:Items infobox/doc: Difference between revisions
From Official Barotrauma Wiki
Jade Harley (talk | contribs) mNo edit summary |
Jade Harley (talk | contribs) mNo edit summary |
||
Line 1: | Line 1: | ||
{{doc/start}} | {{doc/start}} | ||
== Basic == | == Basic == | ||
{|class="wikitable sortable" style="width: 100%;" | {|class="wikitable sortable" style="width: 100%;" | ||
Line 24: | Line 25: | ||
== Stats == | == Stats == | ||
{|class="wikitable sortable" style="width: 100%;" | {|class="wikitable sortable" style="width: 100%;" | ||
!Field!!Note!!Example!!Expected!!Default | !Field!!Note!!Example!!Expected!!Default | ||
Line 100: | Line 100: | ||
|- | |- | ||
| reusable || shows that this ammo is reusable if set to yes, hidden otherwise || yes || yes || hidden | | reusable || shows that this ammo is reusable if set to yes, hidden otherwise || yes || yes || hidden | ||
|} | |||
== Skill Requirements == | |||
{|class="wikitable sortable" style="width: 100%;" | |||
!Field!!Note!!Example!!Expected | |||
|- | |||
| noreq || Skips Skill Requirements section if true || yes || whitespace/empty or string | |||
|- | |||
| weapons || Weapons skill required to handle item without penalty || 10 || number | |||
|- | |||
| mechanical || Mechanical skill required to handle item without penalty || 10 || number | |||
|- | |||
| electrical || Electrical skill required to handle item without penalty || 10 || number | |||
|- | |||
| medical || Medical skill required to handle item without penalty || 10 || number | |||
|- | |||
| handicap || Penalty for not having the correct level for this item || Fuel used up 3x as fast || string | |||
|} | |||
== Crafting == | |||
{|class="wikitable sortable" style="width: 100%;" | |||
!Field!!Note!!Example!!Expected | |||
|- | |||
| fabricator || Is the item constructible in a regular fabricator || yes || yes/no | |||
|- | |||
| medicalfabricator || Is the item constructible in a medical fabricator || yes || yes/no | |||
|- | |||
| talent || What talent is required to craft this item || [[Talents#Captain Talents|Quickdraw]] || link to the talents page with an anchor to the job<br>or link to the specific talent page itself if we make one | |||
|- | |||
| fabricatedamount || How many items are crafted at once (if 1<) || 4 || number | |||
|- | |||
| fabricatortime || Time required to craft item (seconds) || 10 || number | |||
|- | |||
| fabricatorskill || Skill required to craft item || medical || mechanical/electrical/medical/weapons | |||
|- | |||
| fabricatorskilllevel || Skill level required to craft item || 20 || number | |||
|- | |||
| fabricatorskill2 || Second Skill required to craft item || medical || mechanical/electrical/medical/weapons | |||
|- | |||
| fabricatorskilllevel2 || Skill level of the second skill required to craft item || 20 || number | |||
|- | |||
| fabricatormaterials || Items required to craft item || {{Hyperlink|Iron}} || item | |||
|- | |||
| fabricatedamount || Amount of items produced by fabrication || 3 || number | |||
|- | |||
| deconstructor || Is the item deconstructible || yes || yes/no | |||
|- | |||
| deconstructortime || Time required to deconstruct item (seconds) || 10 || number | |||
|- | |||
| deconstructormaterials || Items recieved after deconstructing || {{Hyperlink|Iron}} || item | |||
|} | |} | ||
== Store == | == Store == | ||
{|class="wikitable sortable" style="width: 100%;" | {|class="wikitable sortable" style="width: 100%;" | ||
!Field!!Note!!Example!!Expected | !Field!!Note!!Example!!Expected | ||
Line 122: | Line 171: | ||
* whitespace/empty - Both prices appear | * whitespace/empty - Both prices appear | ||
* true - Sets buy price to N/A | * true - Sets buy price to N/A | ||
|- | |- | ||
| citymultiplier || Price multiplier of item at a Colony || 1.25 || number | | citymultiplier || Price multiplier of item at a Colony || 1.25 || number | ||
Line 131: | Line 179: | ||
* whitespace/empty - Both prices appear | * whitespace/empty - Both prices appear | ||
* true - Sets buy price to N/A | * true - Sets buy price to N/A | ||
|- | |- | ||
| researchmultiplier || Price multiplier of item at the Research Outpost || 1.25 || number | | researchmultiplier || Price multiplier of item at the Research Outpost || 1.25 || number | ||
Line 140: | Line 187: | ||
* whitespace/empty - Both prices appear | * whitespace/empty - Both prices appear | ||
* true - Sets buy price to N/A | * true - Sets buy price to N/A | ||
|- | |- | ||
| militarymultiplier || Price multiplier of item at the Military Outpost || 1.25 || number | | militarymultiplier || Price multiplier of item at the Military Outpost || 1.25 || number | ||
Line 149: | Line 195: | ||
* whitespace/empty - Both prices appear | * whitespace/empty - Both prices appear | ||
* true - Sets buy price to N/A | * true - Sets buy price to N/A | ||
|- | |- | ||
| minemultiplier || Price multiplier of item at the Mining Outpost || 1.25 || number | | minemultiplier || Price multiplier of item at the Mining Outpost || 1.25 || number | ||
Line 158: | Line 203: | ||
* whitespace/empty - Both prices appear | * whitespace/empty - Both prices appear | ||
* true - Sets buy price to N/A | * true - Sets buy price to N/A | ||
|- | |- | ||
| armorymultiplier || Price multiplier of item from this merchant || 1.25 || number | | armorymultiplier || Price multiplier of item from this merchant || 1.25 || number | ||
Line 167: | Line 211: | ||
* whitespace/empty - Both prices appear | * whitespace/empty - Both prices appear | ||
* true - Sets buy price to N/A | * true - Sets buy price to N/A | ||
|} | |} | ||
== Other == | == Other == | ||
{|class="wikitable sortable" style="width: 100%;" | {|class="wikitable sortable" style="width: 100%;" | ||
!Field!!Note!!Example!!Expected | !Field!!Note!!Example!!Expected | ||
|- | |- | ||
| nocat || | | nocat || Removes page categories if defined. || yes || whitespace/empty or string | ||
|} | |} | ||
Revision as of 00:01, 26 August 2022
Basic
Field | Note | Example | Default |
---|---|---|---|
name | Item name | Wrench | {{PAGENAME}}
|
icon | Icon of item | Wrench.png | {{PAGENAME}}.png
|
iconwidth | Forced icon width (px) | 250 | 180 |
caption | Caption under image | Inventory icon | |
sprite | Sprite of item | Wrench_sprite.png | |
spritewdith | Forced sprite width (px) | 90 | 180 |
caption2 | Caption under image | Inventory icon | |
identifier | Internal identifier of the item from game files (optional) | wrench | |
description | In-game item description | Useful for crafting |
Stats
Field | Note | Example | Expected | Default |
---|---|---|---|---|
nostats | Skips Stats section if true | yes | whitespace/empty or string | |
category | The category of the item, as defined in XML. | Machine | Structure, Decorative, Machine, Medical, Weapon, Diving, Equipment, Fuel, Electrical, Material, Alien, Wrecked, Legacy, Misc | Misc |
category2 | The second category of the item, if applicable. | Weapon | Structure, Decorative, Machine, Medical, Weapon, Diving, Equipment, Fuel, Electrical, Material, Alien, Wrecked, Legacy, Misc | |
subcategory | The subcategory of the item, as defined in XML. | Labels | Thalamus, Abandoned Outposts, Abandoned Outpost (Human), Abandoned Outpost (Monster), Exterior submarine walls, Exterior shuttle pieces, Labels, Background wall, Outpost | |
tags | The tags of the item, as defined in XML. | smallitem,tool,simpletool,mechanicalrepairtool,wrenchitem,mountableweapon | CSV list of the item's tags | |
type | Sets category of item depending on the type | weapon | weapon tool gear medical chemical electrical container ammo explosive gatherable misc gardening mineralmaterial organicmaterial processedmaterial rarematerial fuel misc exotic vehicle | General Item |
size | Size of the item. Default is small. | medium | medium/undefined | small |
ammo | Ammo used by an item | Revolver Round | item(s) | |
ammocost | Cost of ammo | 100 Marks | number | |
ammocount | Amount of ammo a item can hold | 4 | number | |
fuel | Fuel used by item | Welding Fuel Tank | item(s) | |
fuelcost | Cost of fuel | 100 Marks | number | |
fuelcount | Amount of fuel an item can hold | 4 | number | |
maxstack | Maximum number of items in a stack | 10 | number | |
payload | Payload used by an item | UEX | item(s) | |
payloadcost | Cost of payload | 100 Marks | number | |
payloadcount | Amount of payloads an item can hold | 1 | number | |
supplyname | Name of item that fits no other field | Food | text | |
supplycost | Cost of supply item | 100 Marks | number | |
supplycount | Amount of supply items an item can hold | 4 | number | |
supplyitems | Supply items used by an item | Battery Cell | item(s) | |
itemcapacity | Amount of generic items a storage item can hold (for containers) | 4 | number |
Damage
Field | Note | Example | Expected | Default |
---|---|---|---|---|
usedby | What weapon(s) use this ammo | Assault Rifle | Hyperlinks to relevant weapons | |
afflictions | Afflictions list. Deprecated, use individual afflictions instead. However, until the transition is over, for compatibility reasons you must set this to "yes" ( |afflictions=yes ). |
yes | yes (Previously: list of afflictions using Template:Affliction) | |
bluntforcetrauma, lacerations, gunshotwound, deeptissueinjury, organdamage, burn, bleeding, oxygenlow, huskinfection, psychosis, morbusinepoisoning, sufforinpoisoning, deliriuminepoisoning, cyanidepoisoning, radiationsickness, paralysis, progressivestun, stun, explosionradiationsickness, explosiondeeptissueinjury, explosionburn, explosionlacerations, explosionbleeding, explosionstun | Each individual affliction | 25 | number | |
blulast, laclast, gunlast... | Use to remove the <br> after an affliction, if there is no stun specified. First 3 letters of the affliction followed by -last. | yes | yes (or any value). Don't use if there is stun. | |
xradlast, xdeelast, xburlast, xlaclast, xblelast | Same as above but for explosion afflictions. "x" - first 3 letters - "last" | yes | yes (or any value). Don't use if there is explosionstun. | |
attackspeed | Number of potential hits per second. This is usually 1/<reload> (+<maxchargetime> if any). | 5 | number | |
explosionrange | Range of explosion if any, in meters (it's in centimeters in the xml). Must be set for the explosionafflictions to be displayed. | 7 | number | |
penetration | Armor penetration | 10 | number | |
structuredamage | Structure damage | 20 | number | |
explosionstructuredamage | Explosion structure damage | 20 | number | |
magazine | Number of rounds in a magazine | 20 | number | |
reusable | shows that this ammo is reusable if set to yes, hidden otherwise | yes | yes | hidden |
Skill Requirements
Field | Note | Example | Expected |
---|---|---|---|
noreq | Skips Skill Requirements section if true | yes | whitespace/empty or string |
weapons | Weapons skill required to handle item without penalty | 10 | number |
mechanical | Mechanical skill required to handle item without penalty | 10 | number |
electrical | Electrical skill required to handle item without penalty | 10 | number |
medical | Medical skill required to handle item without penalty | 10 | number |
handicap | Penalty for not having the correct level for this item | Fuel used up 3x as fast | string |
Crafting
Field | Note | Example | Expected |
---|---|---|---|
fabricator | Is the item constructible in a regular fabricator | yes | yes/no |
medicalfabricator | Is the item constructible in a medical fabricator | yes | yes/no |
talent | What talent is required to craft this item | Quickdraw | link to the talents page with an anchor to the job or link to the specific talent page itself if we make one |
fabricatedamount | How many items are crafted at once (if 1<) | 4 | number |
fabricatortime | Time required to craft item (seconds) | 10 | number |
fabricatorskill | Skill required to craft item | medical | mechanical/electrical/medical/weapons |
fabricatorskilllevel | Skill level required to craft item | 20 | number |
fabricatorskill2 | Second Skill required to craft item | medical | mechanical/electrical/medical/weapons |
fabricatorskilllevel2 | Skill level of the second skill required to craft item | 20 | number |
fabricatormaterials | Items required to craft item | Iron | item |
fabricatedamount | Amount of items produced by fabrication | 3 | number |
deconstructor | Is the item deconstructible | yes | yes/no |
deconstructortime | Time required to deconstruct item (seconds) | 10 | number |
deconstructormaterials | Items recieved after deconstructing | Iron | item |
Store
Field | Note | Example | Expected |
---|---|---|---|
nostore | Skips Store section if true | yes | whitespace/empty or string |
unbuyable | If item can't be bought anywhere | true |
|
baseprice | Base price of item | 200 | number |
outpostmultiplier | Price multiplier of item at the Habitation Outpost | 1.25 | number |
outpostminavailable | Minimum amout of stock available at the Habitation Outpost | 3 | number |
outpostunbuyable | If item is unbuyable in this outpost. Ignored if overall unbuyable=true is set. | true |
|
citymultiplier | Price multiplier of item at a Colony | 1.25 | number |
cityminavailable | Minimum amout of stock available at a Colony | 3 | number |
cityunbuyable | If item is unbuyable in this outpost. Ignored if overall unbuyable=true is set. | true |
|
researchmultiplier | Price multiplier of item at the Research Outpost | 1.25 | number |
researchminavailable | Minimum amout of stock available at the Research Outpost | 3 | number |
researchunbuyable | If item is unbuyable in this outpost. Ignored if overall unbuyable=true is set. | true |
|
militarymultiplier | Price multiplier of item at the Military Outpost | 1.25 | number |
militaryminavailable | Minimum amout of stock available at the Military Outpost | 3 | number |
militaryunbuyable | If item is unbuyable in this outpost. Ignored if overall unbuyable=true is set. | true |
|
minemultiplier | Price multiplier of item at the Mining Outpost | 1.25 | number |
mineminavailable | Minimum amout of stock available at the Mining Outpost | 3 | number |
mineunbuyable | If item is unbuyable in this outpost. Ignored if overall unbuyable=true is set. | all |
|
armorymultiplier | Price multiplier of item from this merchant | 1.25 | number |
armoryminavailable | Minimum amout of stock available from this merchant | 3 | number |
armoryunbuyable | If item is unbuyable at this merchant. Ignored if overall unbuyable=true is set. | all |
|
Other
Field | Note | Example | Expected |
---|---|---|---|
nocat | Removes page categories if defined. | yes | whitespace/empty or string |
Example
Wrench | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Inventory icon Sprite Makes mechanical repairs possible. | |||||||||||||||||||||||||||||||||||
Statistics | |||||||||||||||||||||||||||||||||||
Afflictions | |||||||||||||||||||||||||||||||||||
Attack Speed | 1 | ||||||||||||||||||||||||||||||||||
Structure damage | 2 | ||||||||||||||||||||||||||||||||||
Crafting | |||||||||||||||||||||||||||||||||||
Fabricator Requirements (produces 1 items) |
Skill: Mechanical: 20
| ||||||||||||||||||||||||||||||||||
Deconstructor Yield | |||||||||||||||||||||||||||||||||||
Store | |||||||||||||||||||||||||||||||||||
Base Price | 10 mk | ||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
|
The example seen to the right is defined as follows:
{{Items infobox | name = Wrench | icon = Wrench.png | caption = Inventory icon. | sprite = Wrench sprite.png | spritewidth = 61 | caption2 = Sprite. | identifier = wrench | description = Makes mechanical repairs possible. | category = Equipment | tags = smallitem,tool,simpletool,mechanicalrepairtool,wrenchitem,mountableweapon | type = tool | noreq = yes | afflictions = yes | bluntforcetrauma = 4 | stun = 0.2 | attackspeed = 1 | structuredamage = 2 | baseprice = 10 | outpostmultiplier = 1 | outpostminavailable = 10 | citymultiplier = 0.9 | cityminavailable = 15 | researchmultiplier = 1.25 | researchminavailable = 10 | militarymultiplier = 1.25 | militaryminavailable = 10 | minemultiplier = 1 | mineminavailable = 10 | deconstructor = Yes | fabricator = Yes | fabricatortime = 10 | fabricatorskill = mechanical | fabricatorskilllevel = 20 | fabricatedamount = 1 | deconstructortime = 10 | fabricatormaterials = {{Hyperlink|Iron}} | deconstructormaterials = {{Hyperlink|Iron}} }}
This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.