Template:Infobox item/Sandbox/doc

Documentation

[purge]

This template generates an infobox for items. The Infobox provides a summary of statistics associated with a given item. It is intended to organize the information consistently across all items and provide a quick reference-point for pertinent information about the item.

Formatting and ordering of information is largely done by the template with a few exceptions noted below (sizing images, adding links, etc).

Information is passed to the template in the form of parameters and values that are designated as such: |parameter = value. Parameters containing no value or only whitespace will be ignored and not included in the infobox.

Auto-categorization

Certain parameters enable the template to automatically add the item to other categories. The parameters with this feature are noted below in the list of parameters. This functionality extends the usefulness of the infobox but it may not always be desirable. To disable auto-categorization, add the parameter/value combination: |nocat = 1.

The removed_version parameter also affects auto-categorization by disabling categorization by other parameters to ensure the item is only auto-categorized into Category:Removed_Items. There may be other categories added to the item outside the infobox, which the infobox can not control or manipulate.

Auto-link

If a field is set to auto-link, it will automatically include the [[ and ]] around the field. Thus creating a link to the page that is referenced in this field. The template should make sure that the field is accurate by passing the value through a validation template, normally the Validate list or Validate list list templates.

The removed_version parameter disables also the auto link system.

Boolean Values

Parameters that expect boolean values such as true or false allow for some variation in terminology as in the following:

1, y, yes, t, true = TRUE

0, n, no, f, false = FALSE

For more information, see the documentation for Template:Validate_bool.

Notes

• Please add a small picture of an item you put into the infobox (e.g. ammunition) for the overall look.

 Use this syntax:
 |ammo = [[File:CrossbowBolt.png|20px|link=Crossbow Bolt]][[Crossbow Bolt]]
 will look like: Crossbow Bolt.

• Most values for items can be found in items.xml.

• Information on placeable items, such as traps and mines, are found in blocks.xml.

Syntax

Use the following to easily create new infoboxes. Cut and paste the code then replace needed values, do not remove the lines (leave {"="[nothing]} to do not display them).

Preset

{{Infobox item |name = {{PAGENAME}} |image = |caption = |image_alt1 = |caption_alt1 = |image_alt2 = |caption_alt2 = |size = |nocat = |group = |category = |type = |loot_cont = |slot = |crafting-skill = |action-skill = |durability = |storage = |lockable = |max_load = |mass = |light-opacity = |upgrades_to = |breaks_to = |damage = |pa_damage = |block_damage = |pa_block_damage = |range = |range_effective = |explosive_radius_entities |explosive_radius_blocks |attack_rate = |round_rate = |reload_speed = |mag = |ammo = |stamina_usage = |durability_min = |durability_max = |degradation_rate = |bonus_damage_earth = |bonus_damage_metal = |bonus_damage_stone = |bonus_damage_wood = |butcher_tool = |butcher_damage_multiplier = |butcher_resource_multiplier = |disassemble_tool = |mod_type = |mod_compa = |vehicle_speed_base = |vehicle_speed_sprint = |seats = |hypo-thermal = |hyper-thermal = |waterproof = |damage_resist = |mobility = |sta_regen = |noice = |food = |water = |stamina = |health = |health_max = |cures = |buff = |buff_chance = |buff_effect = |repair = |power_required = |unlocks = |price_base = |stack = |scrappable = |breaks= |scrap_amount = |meltable = |metal = |fuel = |burn-time = |crop = |seed = |grow-time = |obtain = }}

Parameters

Parameter	Legal Values	Description	Auto-categorizes	Auto-links
removed_version		Version in which item was removed (overrides further auto-categorization)	Y
nocat		Disables auto-categorization. Syntax: nocat = true
name		Name to be shown in the header of the infobox, uses {{PAGENAME}} if not specified
image		Main image file name to be displayed
caption		Caption for the main image
image_alt1		First alternative image file name to be displayed
caption_alt1		Caption for the first alternate image
image_alt2		Second alternate image file name to be displayed
caption_alt2		Caption for the second alternate image
size		Size (in px) the image should be displayed at, eg. 75px
Basic Information Section
group	Ammo/Weapons Basics Books Building Chemicals Clothing Decor/Miscellaneous Food/Cooking Mods Science Resources Tools/Traps	The group this item belongs to. (For possible groups see: Item Group) Can be more than one.	Y	Y
category	<Text>	The wiki category in which to place the item. Only one value.	Y
type	<Text>	A comma separated list of a sub-category, depending on the item. For example Melee Weapon, Repair Tool.
loot_cont	<Numeric>	The loot container this container uses.
slot	Hat Glasses Face Overcoat Chest Armor Shirt Gloves Leg Armor Pants Boots Backpack	Gear slot. Example: for bandana slot = face
attribute_focus	<Text>	Which Attribute covers the item; usually for tools and weapons.
Block Properties Section
durability	<Numeric>	Hit Points of a block. Note that blocks use durability without min/max, items with quality levels use durability min/max
storage	<Numeric>	How many storage slots this item has (if container).
lockable	<Boolean>	Whether this item can be locked.	Y
max_load	<Numeric>	See: Max Load
mass	<Numeric>	Weight (only for blocks); see: Mass
light-opacity	<Numeric>	How much light the block blocks.
upgrades_to	<Text>	The block into which it upgrades (Mostly building blocks and doors/hatches)
breaks_to	<Text>	Breaks into what block. (The opposite of the above.)
Weapon/Tool Properties Section
damage	<Numeric>	Damage this item deals to entities; see Entity Damage.
pa_damage	<Numeric>	Power Attack damage this item deals to entities.
block_damage	<Numeric>	Damage this item deals to blocks; see Block Damage.
pa_block_damage	<Numeric>	Power Attack damage this item deals to blocks.
range	<Numeric>	Maximum range for melee and ranged attacks
range_effective	<Numeric>	For ranged weapons, effective range with full damage. See: Range
explosive_radius_entities	<Numeric>	This is the radius of effect of the explosion as applied to entities.
explosive_radius_blocks	<Numeric>	This is the radius of effect of the explosion as applied to blocks.
attack_rate	<Numeric>	Attack rate, units are per minute.
round_rate	<Numeric>	Round rate, units are per minute.
reload_speed	<Numeric>	Time it takes to reload item
mag	<Numeric>	Magazine Size
ammo	<Numeric>	The item this item uses as ammo.
stamina_usage	<Numeric>	How much stamina this item uses.
pa_stamina_usage	<Numeric>	How much stamina this item uses on power attacks.
durability_min	<Numeric>	The durability of an item at its minimum quality. Note that blocks use durability without min/max, items with quality levels use durability min/max
durability_max	<Numeric>	The durability of an item at its maximum quality. Note that blocks use durability without min/max, items with quality levels use durability min/max
degradation_rate	<Numeric>	The rate at which the durability decreases per use when the item is used.
bonus_damage_earth	<Numeric>	Bonus damage to this type of item, expressed as a multiplier
bonus_damage_metal	<Numeric>	Bonus damage to this type of item, expressed as a multiplier
bonus_damage_stone	<Numeric>	Bonus damage to this type of item, expressed as a multiplier
bonus_damage_wood	<Numeric>	Bonus damage to this type of item, expressed as a multiplier
butcher_tool	<Boolean>	If the item is a butcher tool.
butcher_damage_multiplier	<Numeric>	Self-explanatory, usually over 1.
butcher_resource_multiplier	<Numeric>	Self-explanatory, between 0 and 1.
disassemble_tool	<Boolean>	If the item is a disassemble tool.
mod_type	<Text>	The mod's type, eg. Barrel Attachment
mod_compa	<Text>	The mod types this item can have.
Vehicle Properties Section
vehicle_speed_base	<Numeric>	Base speed of a vehicle
vehicle_speed_sprint	<Numeric>	Sprint speed of a vehicle
seats	<Numeric>	The amount of people that can sit in the vehicle at the same time.
Protection Properties Section
hypo-thermal	<Numeric>	Temperature modifier. This is the how much protection against the cold the item provides. An item can have both hypo and hyper attributes.
hyper-thermal	<Numeric>	Temperature modifier. This is the how much protection against heat the item provides. An item can have both hypo and hyper attributes.
waterproof	<Numeric>	How much protection the item provides against water, rain and the like, this will help or hinder with temperature effects.
damage_resist	<Numeric>	The basic armor rating of the armor.
mobility	<Numeric>	What effect the armor has in mobility, eg. -4.1%.
sta_regen	<Numeric>	How much the item reduces stamina regeneration while running, eg. the bigger number that is shown in-game too. For example -1.5%
noise	<Numeric>	How much the item increases the player's noise eg. 20%
Consumption Effects Section
food	<Numeric>	Fullness change when you eat/drink this one.
water	<Numeric>	Thirst change when you eat/drink this one.
stamina	<Numeric>	Stamina change when you eat/drink this one.
health	<Numeric>	Health change when you eat/drink this one.
health_max	<Numeric>	Change to max health when you eat/drink/use this one - Integrated Survival System.
buff	<Text>	Other buffs when you eat/drink this one.
buff_chance	<Numeric>	The chance to obtain said buff.
buff_effect	<Text>	What the buff does.
Characteristic Properties Section
repair	<Text>	The item that is needed to repair this one.
power_required	<Numeric>	The value given is the amount of power required to run this device.
unlocks	<Text>	The item this one unlocks (if any).
price_base		Default Value of an item
stack	<Numeric>	Maximum amount of items in one stack
Scrapping/Forging Properties Section
scrappable	<Boolean>	Whether or not the item can be scrapped.
breaks	<Text>	The material got when scrapping this item.
scrap_amount	<Numeric>	The amount of material got in scrapping.
meltable	<Boolean>	Whether or not the item can be melted in forge.
metal	Brass Sand Iron Lead Stone Clay	The kind of metal this item gives when melted.
fuel	<Boolean>	Whether or not the item can be used as fuel in campfire/forge etc.
burn-time	<Numeric>	amount of time the item burns (in seconds).
Farming Properties Section
crop	<Text>	The item that can be harvested from the plant this seed grows.
seed	<Text>	The seed that can be planted to get this crop.
grow-time	<Numeric>	The time this seed needs to grow to be harvestable.
Obtaining Section
obtain	Cooking Crafting Farming Forging Looting Mining Scrapping Upgrading	How this item can be obtained.

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