From Official Barotrauma Wiki
Documentation
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
|
type |
Sets category of item depending on the type |
weapon |
weapon/tool/gear/chemical/electrical/container/ammo/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, 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
|
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
|
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 |
- whitespace/empty - Both prices appear
- true - Sets buy price to N/A
|
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 |
- whitespace/empty - Both prices appear
- true - Sets buy price to N/A
|
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 |
- whitespace/empty - Both prices appear
- true - Sets buy price to N/A
|
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 |
- whitespace/empty - Both prices appear
- true - Sets buy price to N/A
|
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 |
- whitespace/empty - Both prices appear
- true - Sets buy price to N/A
|
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
|
deconstructor |
Is the item deconstructible |
yes |
yes/no
|
deconstructortime |
Time required to deconstruct item (seconds) |
10 |
number
|
deconstructormaterials |
Items recieved after deconstructing |
Iron |
item
|
Other
Field |
Note |
Example |
Expected
|
nocat |
Doesn't display category if true |
yes |
whitespace/empty or string
|
Example
The example seen to the right is defined as follows:
{{Items infobox
| name = Wrench
| type = tool
| icon = Wrench.png
| noreq = yes
| 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
| 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.