Template:Items Infobox/doc

From Official Barotrauma Wiki
Jump to: navigation, search
Documentation

This template is not used. The current template for items is Template:Items infobox, with a small "i".


Listed below are the fields under every section header, in order of appearance.

Basic

Field Description Example Expected Default
name Name of the item. Wrench {{PAGENAME}}
icon The item's inventory icon. Wrench.png File name {{{name|{{PAGENAME}}}}}.png
iconsize The size of the icon, in px. 64 ## / x## / ##x## {{#if:{{{sprite|}}}|x64|x128}}
sprite The item's world sprite. Wrench sprite.png File name
spritewidth The size of the sprite, in px. 64 ## / x## / ##x## {{{spritesize|{{{iconsize|x64}}}}}}
identifier The identifier of the item, same as XML. wrench
categories The categories of the item, same as XML. Equipment Structure, Decorative, Machine, Medical, Weapon, Diving, Equipment, Fuel, Electrical, Material, Alien, Wrecked, Legacy, Misc Misc
subcategory The subcategory of the item, same as XML. Outpost 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, same as XML. smallitem,tool,simpletool,mechanicalrepairtool,wrenchitem,mountableweapon
nocat Removes page categories if defined.

Quality

Field Description Example Expected Default
qualitybonuses Per-level quality modifiers, seperated by <br>. +10% Repair Speed
qualitytalent Talent which automatically increases the quality level of the item. {{hl|Artisan Smith|32|Talent}} {{hl|[Talent Name]|32|Talent}}

Stats

Field Description Example Expected Default
usedby Items or installations that can use this item, seperated by ,. {{hl|SMG|32}},{{hl|Deadeye Carbine|32}} {{hl|[Item Name]|32}}, {{hl|[Installation Name]|32}}
protects List of limbs protected by armor, seperated by ,. Torso Head, Torso, LeftArm, RightArm, LeftLeg, RightLeg, All
[afflictionname]
  • The strength of an affliction applied on a direct hit (e.g. from a weapon).
  • The strength of an affliction applied after passing a skill check (e.g. from medicine).
    • Strength per second if duration (or durationfail for [afflictionname]fail) is defined.
  • The strength multiplier of a resisted affliction (e.g. from armor) – In this case, prefix the value with *.
  • 10
  • -20


  • *0.5
  • ##
  • ##


  • *##
0
[afflictionname]fail Same as above, but for failing the skill check requirement (e.g. from medicine).
[afflictionname]blockchance Chance to competely block an affliction. (e.g. from armor). 0.25 ## 0
[afflictionname]chance Chance for the affliction to be applied (e.g. from a weapon). 0.5 ##
explosionrange The range of the primary explosion, verbatim as in XML. 1000 ##
explosion[afflictionname] Same as [afflictionname], but for explosions. Points 2 and 3 do not apply.
explosion[afflictionname]chance Same as [afflictionname]chance, but for explosions.
duration The duration that all afflictions are applied for (e.g. from medicine). 10 ## 0
durationfail Same as above, but for failing the skill check.
projectiles Number of projectiles fired by the ammunition. 6 ## 1
aftereffect Identifier of the after effect emitter used by this item (e.g. from a Nuclear Shell). nuclearaftereffectemitter
reload The average delay between shots. 0.1 ##
penetration Armor penetration, verbatim as in XML. 0.25 ##
piercing Amount of limbs that can be hit by a single projectile. 2 ## 1
severlimbsprobabiltiy Base chance to sever a limb or break an armor section. 0.50 ##
explosionseverlimbsprobability Same as above, but for explosions.
structuredamage Damage done to walls/shells per projectile. 42 ##
explosionstructuredamage Same as above, but for explosions.
thalamusdamage Amount of damage done to thalamus parts. 10 ##
magazine Total number of shots that can be fired from a single magazine. 24 ##
maxstack Number of items that can be in a single stack. 8 ## 1
ammo Items used by this item, seperated by ,. {{hl|Battery Cell|32}},{{hl|Fulgurium Battery Cell|32}} {{hl|[Item Name]|32}}
ammocount Maximum amount of ammunition that can be stored in the item. 6 ##
itemcapacity Number of slots in the item's inventory (favor ammo above this). 12 ##
containable List of identifiers and tags that can be stored in the item, seperated by ,. coilgunammo,railgunammo,wrench

Skill Requirements

Field Description Example Expected Default
helm Amount of Helm skill required to use the item properly. 25 ##
weapons Amount of Weapons skill required to use the item properly. 25 ##
medical Amount of Medical skill required to use the item properly. 25 ##
electrical Amount of Electrical Engineering skill required to use the item properly. 25 ##
mechanical Amount of Mechanical Engineering skill required to use the item properly. 25 ##
handicap Penalties applied if the above skill requirement(s) are not met, seperated by <br>. Spread 10 → 16

Gatherable

Field Description Example Expected Default
detachtime Time it takes to detach the item from a wall. 6 ## 4
commonness The item's spawn chance for all biomes and all caves in those biomes.
Specific commonnesses below will override this.
0.67,0.33 ##,## 0,0
commonness_coldcaverns Same as above, but for the "Cold Caverns" biome.
commonness_europanridge Same as above, but for the "Europan Ridge" biome.
commonness_theaphoticplateau Same as above, but for the "The Aphotic Plateau" biome.
commonness_thegreatsea Same as above, but for the "The Great Sea" biome.
commonness_hydrothermalwastes Same as above, but for the "Hydrothermal Wastes" biome.

Crafting

Field Description Example Expected Default
fabricatoramount Number of items produced by one fabrication. 2 ## 1
fabricatorskills Required skills and levels to fabricate the item, seperated by ,. Weapons 40,Medical 50 Helm ##, Weapons ##, Medical ##, Electrical ##, Mechanical ##
fabricatortalent Required talent to fabricate the item. {{hl|Artisan Smith|32|Talent}} {{hl|[Talent Name]|32|Talent}}
fabricatormaterials Required items to fabricate the item, seperated by <br>. {{hl|Iron|32}} (x2)<br>{{hl|Steel Bar|32}} {{hl|[Item Name]|32}} / {{hl|[Item Name]|32}} (x#).
fabricatortime Required time to craft the item. 40 ##
medical[] Same as above 5, but for the medical fabricator instead.
[]alt Same as above 5 (not for amount), but for the alternate recipe (e.g. recycling).
deconstructormaterials Items outputted when the item is deconstructed. {{hl|Iron|32}} (x2)<br>{{hl|Steel Bar|32}} {{hl|[Item Name]|32}} / {{hl|[Item Name]|32}} (x#).
deconstructortime Time it takes to deconstruct the item. 40 ##

Store

Field Description Example Expected Default
sold If the item can be bought at any merchant.
Specific merchant fields below override this.
false false/true true
outpostsold Same as above, but specifically for Habitation Outposts' general merchants.
citysold Same as above, but specifically for Colonies' general merchants.
researchsold Same as above, but specifically for Research Outposts' general merchants.
militarysold Same as above, but specifically for Military Outposts' general merchants.
minesold Same as above, but specifically for Mining Outposts' general merchants.
medicalsold Same as above, but specifically for all stations' Medical merchants.
engineeringsold Same as above, but specifically for all stations' Engineering merchants.
armorysold Same as above, but specifically for all stations' Armory merchants.
baseprice The base price of the item. 200 ##
multiplier The price multiplier of the item for any merchant.
Specific merchant fields below override this.
0.5 ## 1
outpostmultiplier Same as above, but specifically for Habitation Outposts' general merchants.
citymultiplier Same as above, but specifically for Colonies' general merchants.
researchmultiplier Same as above, but specifically for Research Outposts' general merchants.
militarymultiplier Same as above, but specifically for Military Outposts' general merchants.
minemultiplier Same as above, but specifically for Mining Outposts' general merchants.
medicalmultiplier Same as above, but specifically for all stations' Medical merchants.
engineeringmultiplier Same as above, but specifically for all stations' Engineering merchants.
armorymultiplier Same as above, but specifically for all stations' Armory merchants.

     
Wrench

Inventory icon


Sprite
Makes mechanical repairs possible.
Quality
Bonuses +10% Repair Speed 
Related Talent Artisan Smith 
Statistics 
Afflictions Direct hit:
Stun (0.2)*
Blunt Force Trauma (4)* 
Attack Speed 1/s 
Structure Damage
Crafting 
Fabrication
(Produces 1 item)
Iron (x2)
Fabrication time 10 seconds 
Deconstruction Iron
Deconstruction time 10 seconds 
Store
OutpostOutpost  Buy Sell
Habitation OutpostHabitation 20 mk 5 mk
ColonyColony 20 mk 5 mk
Research OutpostResearch 25 mk 6 mk
Military OutpostMilitary 25 mk 6 mk
Mining OutpostMining 20 mk 5 mk
Medicine MerchantMedicine Merchant  N/A 5 mk
Engineering MerchantEngineering Merchant  18 mk 4 mk
Arms DealerArms Dealer  N/A 5 mk
Technical
Identifier wrench
Category Equipment
Tags smallitem, tool, simpletool, mechanicalrepairtool, wrenchitem, mountableweapon
{{Items Infobox 2
| name        = Wrench
| sprite      = Wrench sprite.png
| identifier  = wrench
| description = Makes mechanical repairs possible.
| categories  = Equipment
| tags        = smallitem,tool,simpletool,mechanicalrepairtool,wrenchitem,mountableweapon
<!-- Quality -->
| qualitybonuses   = +10% Repair Speed
| qualitytalent    = {{hl|Artisan Smith|32|Talent}}
<!-- General Stats -->
| bluntforcetrauma = 4
| stun             = 0.2
| reload           = 1
| structuredamage  = 4
<!-- Crafting -->
| fabricatorskill        = Mechanical 20
| fabricatormaterials    = {{hl|Iron|32}} (x2)
| fabricatortime         = 10
| deconstructormaterials = {{hl|Iron|32}}
| deconstructortime      = 10
<!-- Store -->
| baseprice             = 20
| minavailable          = 10
| cityminavailable      = 5
| researchmultiplier    = 1.25
| militarymultiplier    = 1.25
| medicalsold           = false
| engineeringmultiplier = 0.9
| armorysold            = false
}}

     
Morphine

A powerful opiate for treating pain associated with internal injuries, but will cause shortness of breath and eventual dependency with overuse.
Skill Requirements 
Medical
Statistics 
Afflictions Direct hit:
Opiate Addiction (5 | 25)*
Opiate Overdose (10 | 20)*
Opiate Withdrawal (-30 | -30)*
Oxygen Low (20 | 30)*
Damage (Affliction Type) (-50 | -25)*
Burn (-1 | -0.5)* 
Crafting 
Medical Fabrication
(Produces 1 item)
Opium (x2)
Fabrication time 30 seconds 
Deconstruction Opium
Deconstruction time 20 seconds 
Store
OutpostOutpost  Buy Sell
Habitation OutpostHabitation 100 mk 25 mk
ColonyColony 100 mk 25 mk
Research OutpostResearch 100 mk 25 mk
Military OutpostMilitary 100 mk 25 mk
Mining OutpostMining 100 mk 25 mk
Medicine MerchantMedicine Merchant  90 mk 22 mk
Engineering MerchantEngineering Merchant  N/A 25 mk
Arms DealerArms Dealer  N/A 25 mk
Technical
Identifier antidama1
Category Medical
Tags smallitem, chem, medical, syringe
{{Items Infobox 2
| name        = Morphine
| identifier  = antidama1
| description = A powerful opiate for treating pain associated with internal injuries, but will cause shortness of breath and eventual dependency with overuse.
| categories  = Medical
| tags        = smallitem,chem,medical,syringe
<!-- Skill Requirements -->
| medical = 5
<!-- General Stats -->
| maxstack             = 2
| duration             = 10
| damage               = -5
| burn                 = -0.1
| oxygenlow            = 2
| opiateaddiction      = 0.5
| opiateoverdose       = 1
| opiatewithdrawal     = -3
| failduration         = 10
| damagefail           = -2.5
| burnfail             = -0.05
| oxygenlowfail        = 3
| opiateaddictionfail  = 2.5
| opiateoverdosefail   = 2
| opiatewithdrawalfail = -3
<!-- Crafting -->
| medicalfabricatorskill     = Medical 18
| medicalfabricatormaterials = {{hl|Opium|32}} (x2)
| medicalfabricatortime      = 30
| deconstructormaterials     = {{hl|Opium|32}}
| deconstructortime          = 20
<!-- Store -->
| baseprice         = 100
| minavailable      = 12
| medicalmultiplier = 0.9
| engineeringsold   = false
| armorysold        = false
}}

     
Amblygonite

A mineral composed of lithium, aluminum and sodium.
Gatherable
Required Tools, Duration Plasma Cutter, 4s
Commonness - Cold Caverns 0%, 0%*
Commonness - Europan Ridge 80%, 10%*
Commonness - The Aphotic Plateau 90%, 10%*
Commonness - The Great Sea 90%, 10%*
Commonness - Hydrothermal Wastes 60%, 0%
Crafting 
Deconstruction Lithium
Aluminium
Sodium
Deconstruction time 5 seconds 
Store
OutpostOutpost Sell
Habitation OutpostHabitation 55 mk
ColonyColony 62 mk
Research OutpostResearch 50 mk
Military OutpostMilitary 50 mk
Mining OutpostMining 37 mk
Medicine MerchantMedicine Merchant 50 mk
Engineering MerchantEngineering Merchant 50 mk
Arms DealerArms Dealer 50 mk
Technical
Identifier amblygonite
Category Material
Tags smallitem, ore
{{Items Infobox 2
| name        = Amblygonite
| identifier  = amblygonite
| description = A mineral composed of lithium, aluminum and sodium.
| categories  = Material
| tags        = smallitem,ore
<!-- General Stats -->
| maxstack = 8
<!-- Gatherable -->
| detachtool                    = {{hl|Plasma Cutter|32}}
| commonness                    = 0,0
| commonness_europanridge       = 0.8,0.1
| commonness_theaphoticplateau  = 0.9,0.1
| commonness_thegreatsea        = 0.9,0.1
| commonness_hydrothermalwastes = 0.6,0
<!-- Crafting -->
| deconstructormaterials = {{hl|Lithium|32}}<br>{{hl|Aluminium|32}}<br>{{hl|Sodium|32}}
| deconstructortime      = 5
<!-- Store -->
| baseprice               = 200
| unbuyable               = true
| outpostmultiplier       = 1.1
| citymultiplier          = 1.25
| minemultiplier          = 0.75
}}

     
SMG Magazine

A magazine for .45 caliber SMG rounds.
Statistics 
Used by SMG, Deadeye Carbine 
Afflictions Direct hit:
Stun (0.15)*
Gunshot Wound (12.5)*
Bleeding (12.5)* 
Limb Severance Chance 10% 
Structure Damage
Maximum Stack
Crafting 
Fabrication
(Produces 1 item)
Bootcamp
Magnesium
Lead
Steel Bar
Fabrication time 25 seconds 
Alternate recipe
(Produces 1 item)
Bootcamp
Magnesium
Lead
SMG Magazine
Fabrication time 15 seconds 
Deconstruction Lead (≥95%)
Steel Bar
Deconstruction time 10 seconds 
Store
OutpostOutpost  Buy Sell
Habitation OutpostHabitation N/A 37 mk
ColonyColony 125 mk 31 mk
Research OutpostResearch N/A 31 mk
Military OutpostMilitary 90 mk 22 mk
Mining OutpostMining N/A 31 mk
Medicine MerchantMedicine Merchant  N/A 25 mk
Engineering MerchantEngineering Merchant  N/A 25 mk
Arms DealerArms Dealer  90 mk 22 mk
Technical
Identifier smgmagazine
Category Weapon
Tags smallitem, smgammo
{{Items Infobox 2
| name        = SMG Magazine
| identifier  = smgmagazine
| description = A magazine for .45 caliber SMG rounds.
| categories  = Weapon
| tags        = smallitem,smgammo
<!-- General Stats -->
| usedby                = {{hl|SMG}},{{hl|Deadeye Carbine}}
| maxstack              = 2
| gunshotwound          = 12.5
| bleeding              = 12.5
| stun                  = 0.15
| structuredamage       = 5
| severlimbsprobability = 0.1
<!-- Crafting -->
| fabricatorskill        = Weapons 40
| fabricatortalent       = {{hl|Bootcamp|32|Talent}}
| fabricatormaterials    = {{hl|Magnesium|32}}<br>{{hl|Lead|32}}<br>{{hl|Steel Bar|32}}
| fabricatortime         = 25
| fabricatorskillalt     = Weapons 40
| fabricatortalentalt    = {{hl|Bootcamp|32|Talent}}
| fabricatormaterialsalt = {{hl|Magnesium|32}}<br>{{hl|Lead|32}}<br>{{hl|SMG Magazine|32}}
| fabricatortimealt      = 15
| deconstructormaterials = {{hl|Lead|32}} (≥95%)<br>{{hl|Steel Bar|32}}
| deconstructortime      = 10
<!-- Store -->
| baseprice            = 100
| outpostsold          = false
| outpostmultiplier    = 1.5
| citymultiplier       = 1.25
| citsold              = false
| researchsold         = false
| researchmultiplier   = 1.25
| militarymultiplier   = 0.9
| militaryminavailable = 4
| minesold             = false
| minemultiplier       = 1.25
| medicalsold          = false
| engineeringsold      = false
| armorymultiplier     = 0.9
| armoryminavailable   = 4
}}

     
SMG

A .45 caliber submachine gun.
Quality
Bonuses +10% Affliction Strength 
Skill Requirements 
Weapons 50 
Handicap Spread 10 → 16 
Statistics 
Attack Speed 5.71/s 
Ammunition SMG Magazine, Depleted Fuel SMG Magazine 
Crafting 
Deconstruction Steel Bar
Plastic
Deconstruction time 10 seconds 
Store
OutpostOutpost  Buy Sell
Habitation OutpostHabitation N/A 112 mk
ColonyColony N/A 93 mk
Research OutpostResearch N/A 93 mk
Military OutpostMilitary 270 mk 67 mk
Mining OutpostMining N/A 93 mk
Medicine MerchantMedicine Merchant  N/A 75 mk
Engineering MerchantEngineering Merchant  300 mk 75 mk
Arms DealerArms Dealer  270 mk 67 mk
Technical
Identifier smg
Category Weapon
Tags smallitem, weapon, gun, gunsmith, mountableweapon
{{Items Infobox 2
| name        = SMG
| identifier  = smg
| description = A .45 caliber submachine gun.
| categories  = Weapon
| tags        = smallitem,weapon,gun,gunsmith,mountableweapon
<!-- Quality -->
| qualitybonuses   = +10% Affliction Strength
<!-- General Stats -->
| ammo   = {{hl|SMG Magazine}},{{hl|Depleted Fuel SMG Magazine}}
| reload = 0.175
<!-- Required Skills -->
| weapons  = 50
| handicap = Spread 10 → 16
<!-- Crafting -->
| deconstructormaterials = {{hl|Steel Bar|32}}<br>{{hl|Plastic|32}}
| deconstructortime      = 10
<!-- Store -->
| baseprice            = 300
| outpostsold          = false
| outpostmultiplier    = 1.5
| citymultiplier       = 1.25
| citysold             = false
| researchsold         = false
| researchmultiplier   = 1.25
| militarymultiplier   = 0.9
| militaryminavailable = 2
| minesold             = false
| minemultiplier       = 1.25
| medicalsold          = false
| engineeringsole      = false
| armorymultiplier     = 0.9
| armoryminavailable   = 2
}}

     
Body Armor

While the body armor won't offer adequate protection against most of the inhabitants of the subsurface ocean, it can be extremely useful if there are traitors on board.
Statistics 
Damage
Resistances
Direct hit & Explosion:
Bite Wounds (Expression error: Unexpected * operator.)*
Blunt Force Trauma (Expression error: Unexpected * operator.)*
Gunshot Wound (Expression error: Unexpected * operator.)*
Lacerations (Expression error: Unexpected * operator.)*
Burn (Expression error: Unexpected * operator.)*
Bleeding (Expression error: Unexpected * operator.)* 
Crafting 
Fabrication
(Produces 1 item)
Ballistic Fiber (x3)
Fabrication time 30 seconds 
Deconstruction Ballistic Fiber (x2)
Deconstruction time 40 seconds 
Store
OutpostOutpost  Buy Sell
Habitation OutpostHabitation N/A 156 mk
ColonyColony N/A 144 mk
Research OutpostResearch N/A 120 mk
Military OutpostMilitary 432 mk 108 mk
Mining OutpostMining N/A 120 mk
Medicine MerchantMedicine Merchant  N/A 120 mk
Engineering MerchantEngineering Merchant  N/A 120 mk
Arms DealerArms Dealer  432 mk 108 mk
Technical
Identifier bodyarmor
Category Equipment
Tags smallitem, clothing
{{Items Infobox 2
| name        = Body Armor
| identifier  = bodyarmor
| description = While the body armor won't offer adequate protection against most of the inhabitants of the subsurface ocean, it can be extremely useful if there are traitors on board.
| categories  = Equipment
| tags        = smallitem,clothing
<!-- General Stats -->
| protects         = Torso
| burn             = *0.9
| bitewounds       = *0.3
| bluntforcetrauma = *0.2
| lacerations      = *0.2
| gunshotwound     = *0.2
| bleeding         = *0.1
<!-- Crafting -->
| fabricatorskill        = Weapons 40
| fabricatormaterials    = {{hl|Ballistic Fiber|32}} (x3)
| fabricatortime         = 30
| deconstructormaterials = {{hl|Ballistic Fiber|32}} (x2)
| deconstructortime      = 40
<!-- Store -->
| baseprice            = 480
| outpostsold          = false
| outpostmultiplier    = 1.3
| citysold             = false
| citymultiplier       = 1.2
| researchsold         = false
| militaryminavailable = 3
| militarymultiplier   = 0.9
| minesold             = false
| medicalsold          = false
| engineeringsold      = false
| armoryminavailable   = 3
| armorymultiplier     = 0.9
}}

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