Template:Items infobox/doc

Documentation

[purge]

Basic

Field	Note	Example	Expected	Default
name	Item name	Wrench		{{PAGENAME}}
icon	Icon of item	Wrench.png		{{{name|{{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
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
wikidescription	Used by cargo.
sources	Used by cargo.

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

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 DEPRECATED: Use "tags" instead.	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. DEPRECATED: Use "tags" instead.	medium	medium/undefined	small
impacttolerance	The impact tolerance of the item.	8	number
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

Medical Items

Field	Note	Example	Expected
damage	"Any Internal Damage" in strength per second	5	number
combatstimulant, pressurestabilized, incrementalstun, stun, reaperstax, huskinfectionresistance, paralysisresistance, psychosisresistance, strengthen, psychosis, chemwithdrawal, cyanidepoisoning, deleriuminepoisoning, drunk, morbusinepoisoning, opiateaddiction, opiateoverdose, opiatewithdrawal, radiationsickness, sufforinpoisoning, paralysis, oxygenlow, nausea, hyperactivity, watchersgaze, durationincrease, chemaddiction, burn, bloodloss, bleeding, huskinfection	Specific afflictions in strength per second	0.3	number
xxxfail	Any Specific affliction in strength per second when failed	oxygenlow = 1.5	number
duration	The duration of the item's effects on use in seconds	10	number
durationfail	The duration of the item's effects on use in seconds when failed (optional, only use if duration and durationfail would be different)	10	number

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
price	Used for legacy items	100	number
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
medicalmultiplier	Price multiplier of item from this merchant	1.25	number
medicalminavailable	Minimum amout of stock available from this merchant	3	number
medicalunbuyable	If item is unbuyable at this merchant. Ignored if overall unbuyable=true is set.	all	whitespace/empty - Both prices appear true - Sets buy price to N/A
engineeringmultiplier	Price multiplier of item from this merchant	1.25	number
engineeringminavailable	Minimum amout of stock available from this merchant	3	number
engineeringunbuyable	If item is unbuyable at this merchant. Ignored if overall unbuyable=true is set.	all	whitespace/empty - Both prices appear true - Sets buy price to N/A
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	whitespace/empty - Both prices appear true - Sets buy price to N/A

Other

Field	Note	Example	Expected
nocat	Removes page categories if defined.	yes	whitespace/empty or string

Tool Example

Wrench
Dummy link Inventory icon Sprite Makes mechanical repairs possible.
Statistics
Afflictions
Attack Speed	1
Structure damage	2
Crafting
Fabricator Requirements (produces 1 items)	Skill: Mechanical: 20 Iron 10s
Deconstructor Yield	Iron 10s
Store
Base Price	10 mk
Outposts Outpost Buy Sell Habitation 10 mk 3 mk Colony 9 mk 2 mk Research 12 mk 3 mk Military 12 mk 3 mk Mining 10 mk 3 mk Medical Merchant N/A 3 mk Engineer Merchant N/A 3 mk Armory Merchant N/A 3 mk Clown Merchant N/A 3 mk Husk Merchant N/A 3 mk
Technical Identifier wrench Categories Equipment Tags smallitem,tool,simpletool,mechanicalrepairtool,wrenchitem,mountableweapon

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}}
}}

Medical Item Example

Morphine
Dummy link Inventory icon Dummy link Sprite A powerful opiate for treating pain associated with internal injuries, but will cause shortness of breath and eventual dependency with overuse.
Skill Requirements
Skill Requirements	Medical: 30
Crafting
Fabricator Requirements (produces 1 items)	Skill: Medical: 18 Opium x2 30s
Deconstructor Yield	Opium 20s
Store
Base Price	100 mk
Outposts Outpost Buy Sell Habitation 100 mk 30 mk Colony 100 mk 30 mk Research 100 mk 30 mk Military 100 mk 30 mk Mining 100 mk 30 mk Medical Merchant 90 mk 27 mk Engineer Merchant N/A 30 mk Armory Merchant N/A 30 mk Clown Merchant N/A 30 mk Husk Merchant N/A 30 mk
Technical Identifier antidama1 Categories Medical Tags smallitem,chem,medical,syringe

The example seen to the right is defined as follows:

{{Items infobox
| name = Morphine
| icon = Morphine.png
| caption = Inventory icon.
| sprite = Morphine_sprite.png
| spritewidth = 37
| caption2 = Sprite.
| identifier = antidama1
| description = A powerful opiate for treating pain associated with internal injuries, but will cause shortness of breath and eventual dependency with overuse.
| category = Medical
| tags = smallitem,chem,medical,syringe
| noreq = yes
| nostats = yes
| damage = 5
| damagefail = 2.5
| burn = 0.1
| burnfail = 0.05
| oxygenlow = 2
| oxygenlowfail = 3
| opiateaddiction = 0.5
| opiateaddictionfail = 2.5
| opiateoverdose = 1.0
| opiateoverdosefail = 2.0
| opiatewithdrawal = 3.0
| medical = 30
| duration = 10
| baseprice = 100
| minavailable = 10
| researchmultiplier = 1
| outpostmultiplier = 1
| minemultiplier = 1
| militarymultiplier = 1
| citymultiplier = 1
| medicalmultiplier = 0.9
| deconstructor = Yes
| fabricator = Yes
| fabricatortime = 30
| fabricatorskill = medical
| fabricatorskilllevel = 18
| fabricatedamount = 1
| deconstructortime = 20
| fabricatormaterials = {{Hyperlink|Opium}} x2
| deconstructormaterials = {{Hyperlink|Opium}}
| nocat = yes
| usableinhealthinterface = yes
}}

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