Infobox item/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

Inclusion of the template will auto-categorize the article in Category:Items. Additionally, 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 automaticly include the [[ and ]] around the field. Thus creating a link to the page that is referenced in this field. The template in the 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 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

• When using the experience components, exp1 is the inital experience gained for the first use, exp2 is every subsequent use of the item.

• 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). Do not use it for blocks, .., it can be used for small Object-Item page, but the relevant item's values should just be displayed on the object's page.

Preset

{{Infobox item |name = {{PAGENAME}} |image = |caption = |image_alt1 = |caption_alt1 = |image_alt2 = |caption_alt2 = |size = |nocat = |id = |group = |category = |type = |description = |places = |driveable = |vehicle_speed_base = |vehicle_speed_sprint = |hit_points = |durability_min = |durability_max = |degradation_rate = |mass = |smell_tb_str = |smell_tb = |smell_bp_str = |smell_bp = |light_value = |speed = |noise_volume = |activityLevel_strength = |slot = |inv_slots = |stack = |storage = |mobility = |sta_stamina = |lockable = |mod_compa = |price_base = |damage = |pa_damage_ = |block_damage = |pa_block_damage = |velocity = |range = |range_effective = |range_block = |range_repair = |attack_rate = |round_rate = |fire_flash = |fire_volume = |sway = |accuracy_hip = |accuracy = |recoil = |handling = |unholster = |reload_speed = |stamina_usage = |explosive_radius_entities = |explosive_radius_blocks = |bonus_damage_cloth = |bonus_damage_earth = |bonus_damage_metal = |bonus_damage_organic = |bonus_damage_stone = |bonus_damage_water = |bonus_damage_wood = |damage_block_additional = |damage_resist = |ar_penetration = |ar_impact = |ar_fire = |ar_explosion = |ar_radiation = |ar_electrical = |effect_resist = |waterproof = |hypo-thermal = |hyper-thermal = |consu_health = |consu_stamina = |consu_food = |consu_water = |consu_health_max = |consu_foodPoisoning = |consu_cures = |consu_additional = |butcher_tool = |butcher_multiplier = |butcher_damage = |salvage_tool = |salvage_multiplier = |salvage_damage = |hoe_tool = |repair_rate = |ammo = |mag = |requires_power = |metal = |weight_forge = |burn-time = |provides_power = |unlocks = |used_by = |upgradesInto = |upgrades = |used_in = |crafting_ingredient_time = |unlocked = |reqTools = |used_ingredients = |repaired = |scrap_brass = |scrap_cloth = |scrap_electricalParts = |scrap_glass = |scrap_iron = |scrap_lead = |scrap_mechanicalParts = |scrap_paper = |scrap_polymers = |breaks = |seed = |light-opacity = |stages = |grow-time = |plant-grown = |crop = |ob_farm = |ob_loot = |ob_hunt = |ob_mine = |ob_dismant = |ob_lootContainers = |confirmed_version = Alpha 17 }}

Parameters (Outdated)

Parameter	Legal Values	Description	Auto-categorizes	Auto-links
removed		NOTE: Use removed_version instead. 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
group	Ammo/Weapons Basics Books Building Chemicals Clothing Decor/Miscellaneous Food/Cooking Mods Science Resources Tools and Traps	The group this item belongs to. (For possible groups see: Item Group) Can be more than one. Note: "Medicine (Group)" has been replaced by Science in Alpha 16	Y	Y
category		The wiki category in which to place the item.	Y
type		A comma separated list of a sub-category, depending on the item. For example a "semi-automatic" firearm, now includes tool-type	Y
tool-type		No longer needed add to type. Recognized values: Mechanical, Manual	Y
item-id		Item ID number in brackets in creative menu.
CraftingSkillGroup	Armor Smithing (Skill) Gun Smithing (Skill) Leatherworking (Skill) Miscellaneous Crafting (Skill) Science (Skill) Tailoring (Skill) Tool Smithing (Skill) Weapon Smithing (Skill)	The skill used to craft an item. Can be found in items.xml		Y
ActionSkillGroup	Archery (Skill) Athletics (Skill) Barter (Skill) Blade Weapons (Skill) Blunt Weapons (Skill) Construction Tools (Skill) Heavy Armor (Skill) Light Armor (Skill) Medicine (Skill) Mining Tools (Skill) Pistols (Skill) Rifles (Skill) Scavenging (Skill) Shotguns (Skill)	The skill that receives skill points when an item is used. Can be found in items.xml		Y
location
found
breaks		Breaks into which items
slot	Hat Glasses Face Overcoat Chest Armor Shirt Gloves Leg Armor Pants Boots Backpack	Gear slot. Example: for bandana slot = face
tool-fuel		Fuel to use this tool. (There is only Gas Can.)
places
exp		How much experience you gain from this item (First time | Subsequent times)
cookable		Whether this item can be cooked	Y
meltable		Whether this item can be melted	Y
scrapable		Whether this item can be scrapped	Y
dismantleable		Whether this item can be dismantled (taking apart an item to scrap, replace, and/or discard its constituent parts)	Y
lockable		Whether this item can be locked	Y
storage	<Numeric>	How many storage slots this item has (if container)
smell_tb		Smell radius when carried on toolbelt (in m)
smell_tb_str		Smell strength when carried on toolbelt
smell_br		Smell radius when carried in backpack (in m)
smell_br_str		Smell strength when carried in backpack
hit_points	<Numeric>	Hit Points of a block. Note that block use hit points, items with quality levels use Durability
cumulative_durability	<Numeric>	Cumulative Durability of the item, this includes all the durability of the items that this item will Break down into.
durability_min	<Numeric>	The durability of an item at its minimum quality. Note that block use hit points, items with quality levels use Durability
durability_max	<Numeric>	The durability of an item at its maximum quality. Note that block use hit points, items with quality levels use Durability
degradation_rate	<Numeric>	The rate at which the durability decreases per use when the item is used.
driveable		Is this a driveable vehicle
vehicle_speed_base	<Numeric>	Base speed of a vehicle
vehicle_speed_sprint	<Numeric>	Sprint speed of a vehicle
puredur		Pure durability of the item; see: Pure-Dur
hardness		Hardness of the item; see: Hardness
structural integrity	<Numeric>	See: Structural Integrity
max_load	<Numeric>	See: Max Load
mass	<Numeric>	Weight (only for blocks); see: Mass
tool		The Appropriate Tool best to destroy this item (only for blocks)
damage	<Numeric>	Damage this item deals to entities; see Entity Damage
speed	<Numeric>	Time (in seconds) to complete one attack. This is not really speed but a time.
attack_rate	<Numeric>	Attack rate, units are per minute.
round_rate	<Numeric>	Round rate, units are per minute.
pa_damage	<Numeric>	Power Attack damage this item deals to entities; see Entity Damage
block_damage	<Numeric>	Damage this item deals to blocks; see Block Damage
pa_block_damage	<Numeric>	Power Attack damage this item deals to blocks; see Block Damage
explosive_radius_entities	<Numeric>	This is the radius of effect of the explosion as applied to entities, if this field exists then the above field specifies explosive damage.
explosive_radius_blocks	<Numeric>	This is the radius of effect of the explosion as applied to blocks, if this field exists then the above field specifies explosive damage.
range	<Numeric>	Maximum range for melee and ranged attacks
range_effective	<Numeric>	For ranged weapons, effective range with full damage. See: Range
range_block	<Numeric>	When damaging blocks, the maximum range at which blocks will be damaged. See: Range
range_repair	<Numeric>	For repair tools, the maximum repair/upgrade range of the tool. See: Range
bonus_damage_cloth	<Numeric>	Bonus damage to this type of item, expressed as a multiplier
bonus_damage_earth	<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
bonus_damage_stone	<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_organic	<Numeric>	Bonus damage to this type of item, expressed as a multiplier
bonus_damage_water	<Numeric>	Bonus damage to this type of item, expressed as a multiplier
buff		Buff imparted by item.
debuff		Buff removed by item
buff_chance		Percent chance buff will be imparted
buff_effect		How buff affects recipient. buff_effect = -150 HP
heat_map_strength	<Numeric>	Amount of heat generated (found in sounds.xml)	Y
heat_map_time	<Numeric>	Amount of time heat generated remains (found in sounds.xml)
heat_map_frequency		Frequency in ticks that heat is incremented. Applies only to blocks (found in blocks.xml)
reload_speed	<Numeric>	Time it takes to reload item
inv_slots
stack	<Numeric>	Maximum amount of items in one stack
insulation		Deprecated as of A17 Temperature modifier. This is the how much cooling or heating the item provides, negative is a cooling effect and positive is a heating effect.
hypo-thermal		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		Temperature modifier. This is the how much protection against heat the item provides. An item can have both hypo and hyper attributes.
waterproof		How much protection the item provides against water, rain and the like, this will help or hinder with temperature effects.
concussive_min		Concussive protection. Base. This is the protection given by a object of minimum or base quality. These are the displayed values not actual values, the actual values are affected by the quality of the item and its current level of durability from its maximum.
concussive_max		Concussive protection. Maximum. This is the protection given by a object of minimum or base quality. These are the displayed values not actual values, the actual values are affected by the quality of the item and its current level of durability from its maximum.
puncture_min		Punture protection. Base. This is the protection given by a object of minimum or base quality. These are the displayed values not actual values, the actual values are affected by the quality of the item and its current level of durability from its maximum.
puncture_max		Punture protection. Maximum. This is the protection given by a object of minimum or base quality. These are the displayed values not actual values, the actual values are affected by the quality of the item and its current level of durability from its maximum.
radiation_min		Radiation protection. Base. This is the protection given by a object of minimum or base quality. These are the displayed values not actual values, the actual values are affected by the quality of the item and its current level of durability from its maximum.
radiation_max		Radiation protection. Maximum. This is the protection given by a object of minimum or base quality. These are the displayed values not actual values, the actual values are affected by the quality of the item and its current level of durability from its maximum.
fire_min		Fire protection. Base. This is the protection given by a object of minimum or base quality. These are the displayed values not actual values, the actual values are affected by the quality of the item and its current level of durability from its maximum.
fire_max		Fire protection. Maximum. This is the protection given by a object of minimum or base quality. These are the displayed values not actual values, the actual values are affected by the quality of the item and its current level of durability from its maximum.
electrical_min		Electrical protection. Base. This is the protection given by a object of minimum or base quality. These are the displayed values not actual values, the actual values are affected by the quality of the item and its current level of durability from its maximum.
electrical_max		Electrical protection. Maximum. This is the protection given by a object of minimum or base quality. These are the displayed values not actual values, the actual values are affected by the quality of the item and its current level of durability from its maximum.
bullet		No longer used. Bullet protection.
melee		No longer used. Melee protection.
blunt		No longer used. Blunt protection.
explosives		No longer used. Explosives protection.
hunger		Fullness change when you eat/drink this one.
thirst		Thirst change when you eat/drink this one.
health		Health change when you eat/drink this one.
health_max		Change to max health when you eat/drink/use this one - Integrated Survival System.
stamina		Stamina change when you eat/drink this one.
stamina_max		Change to max stamina when you eat/drink/use this one - Integrated Survival System.
poisoning		Food Poisoning chance when you eat/drink this one.
well		No longer usedWellness change when you eat/drink this one. System replaced by max health/stamina degradation - Integrated Survival System
gas		No longer used. Gassiness change when you eat/drink this one. System replaced by max health/stamina degradation - Integrated Survival System
consumption		Other effects when you eat/drink this one.
ammo		The item this item uses as ammo (if any)
clip		Amount of ammo that fits in one clip
used_by
unlocks		The item this one unlocks (if any)
unlocked		The item that unlocks this one (eg. schematic)
repair		The item that is needed to repair this one
repair_speed		How many seconds it take to perform one repair action (counter-intuitive, this is not really speed, plan to change)
repair_amount		The amount of repair done with each repair action
used_in		Items you can craft with this one.
used parts		Parts used to assembly.
used in upgrading		This is a badly named field, or maybe it has changed meaning. What it currently means is what this item is upgraded to Wood Frame ---> Old Wood
crafting_ingredient_time		The base time that this resource adds to the the crafting time, e.g. wood has a value of 0.25 seconds, so a base value Wood Frame would take 2.5 seconds.
frame
used_parts_upgrading		Items used to upgrade this one.
unlocked_cooking
used in cooking
provides_power	<integer>	Shows that this block or item provides electrical power , and can be used as a power source. A block can have both provides_power and requires_power value, and if it does then it is a distribution box, or power relay.
requires_power	<integer>	Shows that this block or item requires electrical power, the value given is the amount of power required to run this device. A block can have both provides_power and requires_power value, and if it does then it is a distribution box, or power relay, in this case the requires_power value is the amount that this device uses, can be 0.
used_utensil
used_ingredients		Ingredients used to cook this one.
unlocked_chemistry
used_in_chemistry
used_ingredients_chemistry
used_in_forging
weight		Weight in lbs
weight_forge		How much 'metal' this item gives when melted
metal		The kind of metal this item gives when melted
fuel		whether the item can be burnt
burn-time		amount of time the item burns (in secs)
ob_cheat		whether the item is obtainable through creative menu	Y
ob_cook		whether the item is obtainable through cooking	Y
ob_craft		whether the item is obtainable through crafting	Y
ob_dismantle		whether the item is obtainable through dismanteling	Y
ob_farm		whether the item is obtainable through farming	Y
ob_forge		whether the item is obtainable through forging	Y
ob_loot		whether the item is obtainable through looting	Y
ob_mine		whether the item is obtainable through mining	Y
ob_scavenge		whether the item is obtainable through scavenging	Y
ob_scrap		whether the item is obtainable through scrapping	Y
ob_upgrade		whether the item is obtainable through upgrading	Y
scrap_additional		Additional non-listed scrap result this item gives when scrapped	Y
scrap_brass		How much Brass this item gives when scrapped	Y
scrap_cloth		How much Cloth this item gives when scrapped	Y
scrap_electricalParts		How much Electrical Parts this item gives when scrapped	Y
scrap_glass		How much Glass this item gives when scrapped	Y
scrap_iron		How much Iron this item gives when scrapped	Y
scrap_lead		How much Lead this item gives when scraped	Y
scrap_mechanicalParts		How much Mechanical Parts this item gives when scrapped	Y
scrap_paper		How much Paper this item gives when scrapped	Y
scrap_polymers		How much Scrap Polymers this item gives when scrapped	Y
scrap_tungsten		How much Scrap Tungsten this item gives when scrapped	Y
added_version	<Version String>	The version of 7D2D that the item was added.	Always
removed_version	<Version String>	<Version String> The version of 7D2D that the item was removed. Replaces the removed field.	Y
updated_version	<Version String> [, <Version String> ...]	A comma separated list of versions that the item has been updated. Note: These can not be links.	Always
confirmed_version	<Version String> [, <Version String> ...]	A comma separated list of versions that the item has been comfirmed to be working. Should only be updated to the latest version when the details have been confirmed to be correct. Note: These can not be links.	Always

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