Template:Items infobox/doc: Difference between revisions

From Official Barotrauma Wiki
Jump to: navigation, search
No edit summary
(Updated)
Line 1: Line 1:
{{doc/start}}
{{doc/start}}
<pre>
{{Items infobox
{{Items infobox
| name = Item name
| name = Wrench
| type = Type of item (general, tool, weapon, chemical, gear, container, electrical component, ammo, fuel, vehicle, exotic, misc)
| type = tool
| image = image.png
| image = Wrench.png
| imagewidth = Image width
| noreq = yes
| caption = Caption under the image
| baseprice = 10
| ammo/fuel/equipment = What ammo/fuel the item uses (eg. Oxygen Tank, Welding Tank, Rounds, Spears, Battery Cell, etc...)
| outpostmultiplier = 1
| cost = Item cost in the campaign store | If displaying multiple prices they must be arranged as: Research/Military/City/Outpost
| outpostminavailable = 10
| sellprice = Item selling price to outposts in the campaign store
| citymultiplier = 0.9
| ammocost/fuelcost/equipmentcost = Cost of ammo/fuel/equipment in the campaign store
| cityminavailable = 15
| ammocount/fuelcount/storagecapacity = Amount of ammo/fuel/other items the item can hold
| researchmultiplier = 1.25
| noreq = Does the item NOT have any skill requirements (If set to "yes" the "Skill Requirements" section won't appear)
| researchminavailable = 10
| weapons = Weapons level required to handle item without penalty
| militarymultiplier = 1.25
| medical = Medical skill required to handle item without penalty
| militaryminavailable = 10
| construction = Construction level required to handle item without penalty
| minemultiplier = 1
| handicap = The penalty for not having the correct level for this item
| mineminavailable = 10
| noraw = Can the item NOT be constructed from raw materials (If set to "yes" the "Raw Materials" section won't appear)
| deconstructor = Yes
| fabricator = Can the item be fabricated? (yes/no)
| fabricator = Yes
| deconstructor = Can the item be deconstructed? (yes/no)
| fabricatortime = 10
| materials = Materials from which the item is fabricated or deconstructed
| deconstructortime = 10
| fabricatormaterials = {{Hyperlink|Iron}}
| deconstructormaterials = {{Hyperlink|Iron}}
}}
}}
</pre>
==Fields==
===Basic===
{|class="wikitable sortable" style="width: 70%;"
!Field!!Note!!Example!!Default
|-
| name || Item name || Wrench || <code><nowiki>{{PAGENAME}}</nowiki></code>
|-
| image || Image of item || Wrench.png || <code><nowiki>{{PAGENAME}}</nowiki>.png</code>
|-
| imagewidth || Forced image width (px) || 250 || 180
|-
| caption || Caption under image || Inventory icon || 
|-
| image2 || Image of item || Wrench.png ||
|-
| imagewidth2 || Forced image width (px) || 90 || 180
|-
| caption2 || Caption under image || Inventory icon || 
|}
 
===Stats===
 
{|class="wikitable sortable" style="width: 70%;"
!Field!!Note!!Example!!Expected!!Default
|-
| nostats || Skips Stats section if true || yes || whitespace/empty or string
|-
| type || Sets category of item depending on the type || weapon || weapon/tool/gear/chemical/electrical/container/ammo/fuel/misc/exotic/vehicle || General [[:Category:Items|Item]]
|-
| ammo || Ammo used by an item || {{Hyperlink|Revolver Round}} || item
|-
| ammocost || Cost of ammo || 100 Marks || number
|-
| ammocount || Amount of ammo a item can hold || 4 || number
|-
| fuel || Fuel used by item || {{Hyperlink|Revolver Round}} || item
|-
| fuelcost || Cost of fuel || 100 Marks || number
|-
| fuelcount || Amount of fuel an item can hold || 4 || number
|-
| payload || Payload used by an item || {{Hyperlink|Revolver Round}} || item
|-
| 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
|-
| itemcapacity || Amount of generic items a storage item can hold (for containers) || 4 || number
|}
 
===Store===
 
{|class="wikitable sortable" style="width: 70%;"
!Field!!Note!!Example!!Expected
|-
| nostore || Skips Store section if true || yes || whitespace/empty or string
|-
| unbuyable || If item can't be bought anywhere || true ||
* whitespace/empty - Both sections appear
* true - Hides Buy column
|-
| unsellable || If item can't be sold anywhere || true ||
* whitespace/empty - Both sections appear
* true - Hides Sell column
|-
| 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 only in this outpost, or all outposts || true ||
* whitespace/empty - Both prices appear
* true - Sets buy price to N/A
* all - Hides buy price
|-
| outpostunsellable || If item is unsellable only in this outpost, or all outposts || true ||
* whitespace/empty - Both prices appear
* true - Sets sell price to N/A
* all - Hides sell price
 
|-
| 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 only in this outpost, or all outposts || true ||
* whitespace/empty - Both prices appear
* true - Sets buy price to N/A
* all - Hides buy price
|-
| cityunsellable || If item is unsellable only in this outpost, or all outposts || true ||
* whitespace/empty - Both prices appear
* true - Sets sell price to N/A
* all - Hides sell price
 
|-
| 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 only in this outpost, or all outposts || true ||
* whitespace/empty - Both prices appear
* true - Sets buy price to N/A
* all - Hides buy price
|-
| researchunsellable || If item is unsellable only in this outpost, or all outposts || true ||
* whitespace/empty - Both prices appear
* true - Sets sell price to N/A
* all - Hides sell price
 
|-
| 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 only in this outpost, or all outposts || true ||
* whitespace/empty - Both prices appear
* true - Sets buy price to N/A
* all - Hides buy price
|-
| militaryunsellable || If item is unsellable only in this outpost, or all outposts || all ||
* whitespace/empty - Both prices appear
* true - Sets sell price to N/A
* all - Hides sell price
 
|-
| 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 only in this outpost, or all outposts || all ||
* whitespace/empty - Both prices appear
* true - Sets buy price to N/A
* all - Hides buy price
|-
| mineunsellable || If item is unsellable only in this outpost, or all outposts || all ||
* whitespace/empty - Both prices appear
* true - Sets sell price to N/A
* all - Hides sell price
|}
 
== Skill Requirements ==
 
{|class="wikitable sortable" style="width: 70%;"
!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 || 10 || number
|}
 
== Crafting ==
 
{|class="wikitable sortable" style="width: 70%;"
!Field!!Note!!Example!!Expected
|-
| fabricator || Is the item constructible || yes || yes/no
|-
| fabricatortime || Time required to craft item (seconds) || 10 || number
|-
| fabricatorskill || Skill required to craft item || medical || mechanical/electrical/medical/weapons
|-
| fabricatorskill || Skill level required to craft item || 20 || number
|-
| fabricatormaterials || Items required to craft item || {{Hyperlink|Iron}} || item
|-
| 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
|-
| medicalfabricatormaterials || Items required to craft item || {{Hyperlink|Stabilozine||icon}} || item
|}
 
== Other ==
 
{|class="wikitable sortable" style="width: 70%;"
!Field!!Note!!Example!!Expected
|-
| nocat || Doesn't display category if true || yes || whitespace/empty or string
|}
{{doc/end}}
{{doc/end}}

Revision as of 16:55, 1 November 2020

Documentation
[purge]
Wrench
Click to upload a new image.Dummy link
Inventory icon


Sprite
Crafting
Fabricator
Requirements
Iron
Fabrication time 10s
Deconstructor Yield
Iron
10s
Store
Base Price 10 mk
Outposts
OutpostOutpost Buy Sell
Habitation OutpostHabitation 10 mk 3 mk
ColonyColony 9 mk 2 mk
Research OutpostResearch 12 mk 3 mk
Military OutpostMilitary 12 mk 3 mk
Mining OutpostMining 10 mk 3 mk
Medical MerchantMedical Merchant N/A 3 mk
Engineer MerchantEngineer Merchant N/A 3 mk
Armory MerchantArmory Merchant N/A 3 mk
Children of The HonkmotherClown Merchant N/A 3 mk
The Church of HuskHusk Merchant N/A 3 mk
Technical
Identifier
Categories

Fields

Basic

Field Note Example Default
name Item name Wrench {{PAGENAME}}
image Image of item Wrench.png {{PAGENAME}}.png
imagewidth Forced image width (px) 250 180
caption Caption under image Inventory icon
image2 Image of item Wrench.png
imagewidth2 Forced image width (px) 90 180
caption2 Caption under image Inventory icon

Stats

Field Note Example Expected Default
nostats Skips Stats section if true yes whitespace/empty or string
type Sets category of item depending on the type weapon weapon/tool/gear/chemical/electrical/container/ammo/fuel/misc/exotic/vehicle General Item
ammo Ammo used by an item Revolver Round item
ammocost Cost of ammo 100 Marks number
ammocount Amount of ammo a item can hold 4 number
fuel Fuel used by item Revolver Round item
fuelcost Cost of fuel 100 Marks number
fuelcount Amount of fuel an item can hold 4 number
payload Payload used by an item Revolver Round item
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
itemcapacity Amount of generic items a storage item can hold (for containers) 4 number

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
  • whitespace/empty - Both sections appear
  • true - Hides Buy column
unsellable If item can't be sold anywhere true
  • whitespace/empty - Both sections appear
  • true - Hides Sell column
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 only in this outpost, or all outposts true
  • whitespace/empty - Both prices appear
  • true - Sets buy price to N/A
  • all - Hides buy price
outpostunsellable If item is unsellable only in this outpost, or all outposts true
  • whitespace/empty - Both prices appear
  • true - Sets sell price to N/A
  • all - Hides sell price
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 only in this outpost, or all outposts true
  • whitespace/empty - Both prices appear
  • true - Sets buy price to N/A
  • all - Hides buy price
cityunsellable If item is unsellable only in this outpost, or all outposts true
  • whitespace/empty - Both prices appear
  • true - Sets sell price to N/A
  • all - Hides sell price
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 only in this outpost, or all outposts true
  • whitespace/empty - Both prices appear
  • true - Sets buy price to N/A
  • all - Hides buy price
researchunsellable If item is unsellable only in this outpost, or all outposts true
  • whitespace/empty - Both prices appear
  • true - Sets sell price to N/A
  • all - Hides sell price
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 only in this outpost, or all outposts true
  • whitespace/empty - Both prices appear
  • true - Sets buy price to N/A
  • all - Hides buy price
militaryunsellable If item is unsellable only in this outpost, or all outposts all
  • whitespace/empty - Both prices appear
  • true - Sets sell price to N/A
  • all - Hides sell price
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 only in this outpost, or all outposts all
  • whitespace/empty - Both prices appear
  • true - Sets buy price to N/A
  • all - Hides buy price
mineunsellable If item is unsellable only in this outpost, or all outposts all
  • whitespace/empty - Both prices appear
  • true - Sets sell price to N/A
  • all - Hides sell price

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 10 number

Crafting

Field Note Example Expected
fabricator Is the item constructible yes yes/no
fabricatortime Time required to craft item (seconds) 10 number
fabricatorskill Skill required to craft item medical mechanical/electrical/medical/weapons
fabricatorskill Skill level required to craft item 20 number
fabricatormaterials Items required to craft item Iron item
deconstructor Is the item deconstructible yes yes/no
deconstructortime Time required to deconstruct item (seconds) 10 number
deconstructormaterials Items recieved after deconstructing Iron item
medicalfabricatormaterials Items required to craft item Stabilozine item

Other

Field Note Example Expected
nocat Doesn't display category if true yes whitespace/empty or string

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.

Retrieved from "https://barotraumagame.com/baro-wiki/index.php?title=Template:Items_infobox/doc&oldid=7160"