From Official Barotrauma Wiki
Documentation
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
|
maxstack |
Maximum number of items in a stack |
10 |
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
|
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
|
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.