Trevor1097 (talk | contribs) m (perk_affect now perk_modified) |
No edit summary |
||
(11 intermediate revisions by 2 users not shown) | |||
Line 9: | Line 9: | ||
==Auto-categorization== |
==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: <code>|nocat = 1</code>. |
|
The <code>removed_version</code> 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. |
The <code>removed_version</code> 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== |
==Auto-link== |
||
ā | If a field is set to auto-link, it will |
+ | If a field is set to auto-link, it will automatically include the '''<nowiki>[[</nowiki>''' and '''<nowiki>]]</nowiki>''' 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 <code>removed_version</code> parameter disables the auto link system. |
+ | The <code>removed_version</code> parameter disables also the auto link system. |
==Boolean Values== |
==Boolean Values== |
||
Line 24: | Line 25: | ||
::0, n, no, f, false = FALSE |
::0, n, no, f, false = FALSE |
||
ā | For more information, see the documentation for [[Template:Validate_bool]] |
+ | For more information, see the documentation for [[Template:Validate_bool]]. |
== Notes == |
== Notes == |
||
Line 30: | Line 31: | ||
Use this syntax: |
Use this syntax: |
||
<nowiki>|ammo = [[File:CrossbowBolt.png|20px|link=Crossbow Bolt]][[Crossbow Bolt]]</nowiki> |
<nowiki>|ammo = [[File:CrossbowBolt.png|20px|link=Crossbow Bolt]][[Crossbow Bolt]]</nowiki> |
||
ā | will look like: [[File:CrossbowBolt.png|20px|link=Crossbow Bolt]][[Crossbow Bolt]] |
+ | will look like: [[File:CrossbowBolt.png|20px|link=Crossbow Bolt]][[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. |
* Most values for items can be found in items.xml. |
||
ā | * Information on placeable items, such as traps and mines, are found in blocks.xml |
+ | * Information on placeable items, such as traps and mines, are found in blocks.xml. |
== Syntax == |
== 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) |
+ | 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). |
{| class="wikitable mw-collapsible mw-collapsed" style="width: 60%" |
{| class="wikitable mw-collapsible mw-collapsed" style="width: 60%" |
||
Line 46: | Line 45: | ||
|<pre> |
|<pre> |
||
{{Infobox item |
{{Infobox item |
||
ā | |name = |
+ | |name = |
|image = |
|image = |
||
|caption = |
|caption = |
||
Line 55: | Line 54: | ||
|size = |
|size = |
||
ā | | |
+ | |group = |
ā | | |
+ | |category = |
ā | | |
+ | |type = |
ā | | |
+ | |loot_cont = |
ā | | |
+ | |slot = |
+ | |attribute_focus = |
||
ā | |description = |
||
ā | |places = |
||
ā | |driveable = |
||
ā | |vehicle_speed_base = |
||
ā | |vehicle_speed_sprint = |
||
ā | |durability = |
+ | |durability = |
+ | |storage = |
||
ā | |durability_min = |
||
+ | |lockable = |
||
ā | |durability_max = |
||
+ | |max_load = |
||
ā | |degradation_rate = |
||
ā | |mass = |
+ | |mass = |
+ | |light-opacity = |
||
ā | |smell_tb_str = |
||
+ | |upgrades_to = |
||
ā | |smell_tb = |
||
+ | |breaks_to = |
||
ā | |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 = |
+ | |damage = |
ā | | |
+ | |pa_damage = |
ā | |block_damage = |
+ | |block_damage = |
ā | |pa_block_damage = |
+ | |pa_block_damage = |
ā | | |
+ | |range = |
+ | |range_effective = |
||
ā | |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_entities = |
||
|explosive_radius_blocks = |
|explosive_radius_blocks = |
||
+ | |attack_rate = |
||
ā | |bonus_damage_cloth = |
||
+ | |round_rate = |
||
ā | |bonus_damage_earth = |
||
+ | |reload_speed = |
||
ā | |bonus_damage_metal = |
||
+ | |mag = |
||
ā | |bonus_damage_organic = |
||
+ | |ammo = |
||
ā | |bonus_damage_stone = |
||
+ | |stamina_usage = |
||
ā | |bonus_damage_water = |
||
+ | |durability_min = |
||
ā | |bonus_damage_wood = |
||
+ | |durability_max = |
||
ā | |damage_block_additional = |
||
+ | |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 = |
||
ā | |damage_resist = |
||
+ | |hyper-thermal = |
||
ā | |ar_penetration = |
||
ā | | |
+ | |waterproof = |
+ | |damage_resist = |
||
ā | |ar_fire = |
||
+ | |mobility = |
||
ā | |ar_explosion = |
||
+ | |sta_regen = |
||
ā | |ar_radiation = |
||
+ | |noise = |
||
ā | |ar_electrical = |
||
ā | |effect_resist = |
||
ā | |waterproof = |
||
ā | |hypo-thermal = |
||
ā | |hyper-thermal = |
||
+ | |food = |
||
ā | |consu_health = |
||
+ | |water = |
||
ā | |consu_stamina = |
||
ā | | |
+ | |stamina = |
+ | |health = |
||
ā | |consu_water = |
||
+ | |health_max = |
||
ā | |consu_health_max = |
||
+ | |cures = |
||
ā | |consu_foodPoisoning = |
||
+ | |buff = |
||
ā | |consu_cures = |
||
+ | |buff_chance = |
||
ā | |consu_additional = |
||
+ | |buff_effect = |
||
+ | |dysentery_chance = |
||
+ | |repair = |
||
ā | |butcher_tool = |
||
+ | |power_required = |
||
ā | |butcher_multiplier = |
||
+ | |unlocks = |
||
ā | |butcher_damage = |
||
+ | |price_base = |
||
ā | |salvage_tool = |
||
+ | |stack = |
||
ā | |salvage_multiplier = |
||
ā | |salvage_damage = |
||
ā | |hoe_tool = |
||
ā | |repair_rate = |
||
ā | |||
ā | |ammo = |
||
ā | |mag = |
||
ā | |requires_power = |
||
ā | |||
ā | |metal = |
||
ā | |weight_forge = |
||
ā | |burn-time = |
||
ā | |provides_power = |
||
ā | |||
ā | |unlocks = |
||
ā | |used_by = |
||
ā | |upgradesInto = |
||
ā | |used_in = |
||
ā | |crafting_ingredient_time = |
||
ā | |||
ā | |unlocked = |
||
ā | |used_ingredients = |
||
ā | |repaired = |
||
ā | |scrap_brass = |
||
ā | |scrap_cloth = |
||
ā | |scrap_electricalParts = |
||
ā | |scrap_glass = |
||
ā | |scrap_iron = |
||
ā | |scrap_lead = |
||
ā | |scrap_mechanicalParts = |
||
ā | |scrap_militaryfiber = |
||
ā | |scrap_paper = |
||
ā | |scrap_plantfiber = |
||
ā | |scrap_polymers = |
||
ā | |breaks = |
||
ā | | |
+ | |scrappable = |
+ | |breaks= |
||
ā | |light-opacity = |
||
ā | | |
+ | |meltable = |
ā | | |
+ | |metal = |
+ | |fuel = |
||
ā | |plant-grown = |
||
ā | | |
+ | |burn-time = |
ā | | |
+ | |crop = |
ā | | |
+ | |seed = |
ā | | |
+ | |grow-time = |
ā | |ob_mine = |
||
ā | |ob_dismant = |
||
ā | |ob_lootContainers = |
||
+ | |obtain = |
||
ā | |confirmed_version = Alpha 17 |
||
}} |
}} |
||
</pre> |
</pre> |
||
Line 210: | Line 152: | ||
! style="width: 10%"|Auto-links |
! style="width: 10%"|Auto-links |
||
|- |
|- |
||
ā | | |
+ | |removed_version || || Version in which item was removed (overrides further auto-categorization) || style="text-align:center"|Y |
|- |
|- |
||
|nocat || || Disables auto-categorization. Syntax: <code>nocat = true</code> || |
|nocat || || Disables auto-categorization. Syntax: <code>nocat = true</code> || |
||
Line 230: | Line 172: | ||
|size || || Size (in px) the image should be displayed at, eg. 75px || |
|size || || Size (in px) the image should be displayed at, eg. 75px || |
||
|- |
|- |
||
ā | | colspan="5" style="text-align:center" | <h2> |
+ | | colspan="5" style="text-align:center" | <h2>Basic Information Section</h2> |
|- |
|- |
||
|group || |
|group || |
||
Line 246: | Line 188: | ||
*[[Tools/Traps]] |
*[[Tools/Traps]] |
||
| The group this item belongs to. (For possible groups see: [[Item Group]])<br> Can be more than one. |
| The group this item belongs to. (For possible groups see: [[Item Group]])<br> Can be more than one. |
||
ā | * Note: '''"Medicine (Group)"''' has been replaced by Science in Alpha 16 |
||
| style="text-align:center"|Y || style="text-align:center"|Y |
| style="text-align:center"|Y || style="text-align:center"|Y |
||
|- |
|- |
||
+ | |category || |
||
ā | |category || || The wiki category in which to place the item. || style="text-align:center"|Y |
||
+ | *Ammo |
||
+ | *Melee Weapon |
||
+ | *Ranged Weapon |
||
+ | *Explosive |
||
+ | *Tool |
||
+ | *Book |
||
+ | *Building Block |
||
+ | *Furniture |
||
+ | *Clothing |
||
+ | *Armor |
||
+ | *Food |
||
+ | *Beverage |
||
+ | *Seed |
||
+ | *Armor Mod |
||
+ | *Weapon Mod |
||
+ | *Trap |
||
+ | *Resource |
||
+ | *Plant |
||
+ | *Vehicle |
||
+ | | The wiki category/categories in which to place the item. || style="text-align:center"|Y |
||
|- |
|- |
||
ā | |type || || A comma separated list of a sub-category, depending on the item. For example |
+ | |type || style="text-align:center" | '''''<Text>''''' || A comma separated list of a sub-category, depending on the item. For example Melee Weapon, Repair Tool. || |
|- |
|- |
||
+ | |loot_cont || style="text-align:center" | '''''<Numeric>''''' || The loot container this container uses. || |
||
ā | |item-id || || Item ID number in brackets in creative menu. || |
||
ā | |- |
||
ā | | colspan="5" style="text-align:center" | <h2>Characteristics Section</h2> |
||
|- |
|- |
||
|slot || |
|slot || |
||
Line 271: | Line 230: | ||
|Gear slot. Example: for bandana <code>slot = face</code> || |
|Gear slot. Example: for bandana <code>slot = face</code> || |
||
|- |
|- |
||
+ | |attribute_focus || style="text-align:center" | '''''<Text>''''' || Which [[Perks#Attributes|Attribute]] covers the item; usually for tools and weapons. || |
||
ā | |places || || || |
||
|- |
|- |
||
ā | | |
+ | | colspan="5" style="text-align:center" | <h2>Block Properties Section</h2> |
|- |
|- |
||
ā | | |
+ | |durability||style="text-align:center"|'''''<Numeric>''''' || Hit Points of a block. Note that blocks use durability without min/max, items with quality levels use durability min/max || |
|- |
|- |
||
+ | |storage ||style="text-align:center"|'''''<Numeric>''''' || How many storage slots this item has (if container). || |
||
ā | |smell_tb || || Smell radius when carried on toolbelt (in m) || |
||
|- |
|- |
||
+ | |lockable || style="text-align:center" | '''''<Boolean>''''' || Whether this item can be locked. || style="text-align:center"|Y |
||
ā | |smell_tb_str || || Smell strength when carried on toolbelt || |
||
|- |
|- |
||
+ | |max_load || style="text-align:center"| '''''<Numeric>''''' || See: [[Max Load]] || |
||
ā | |smell_br || || Smell radius when carried in backpack (in m) || |
||
|- |
|- |
||
+ | |mass || style="text-align:center"| '''''<Numeric>'''''|| Weight (only for blocks); see: [[Mass]] || |
||
ā | |smell_br_str || || Smell strength when carried in backpack || |
||
|- |
|- |
||
ā | | |
+ | |light-opacity || style="text-align:center" | '''''<Numeric>''''' || How much light the block blocks. || |
|- |
|- |
||
ā | | |
+ | |upgrades_to|| style="text-align:center" | '''''<Text>''''' || The block into which it upgrades (Mostly building blocks and doors/hatches) || |
|- |
|- |
||
ā | | |
+ | |breaks_to|| style="text-align:center" | '''''<Text>''''' ||Breaks into what block. (The opposite of the above.)|| |
|- |
|- |
||
+ | | colspan="5" style="text-align:center" | <h2>Weapon/Tool Properties Section</h2> |
||
ā | |degradation_rate ||style="text-align:center"|'''''<Numeric>''''' || The rate at which the durability decreases per use when the item is used. || |
||
|- |
|- |
||
+ | |damage || style="text-align:center"|'''''<Numeric>'''''|| Damage this item deals to entities; see [[Entity Damage]]. || |
||
ā | |driveable|| | || Is this a driveable vehicle || |
||
|- |
|- |
||
ā | | |
+ | |pa_damage || style="text-align:center"|'''''<Numeric>'''''|| Power Attack damage this item deals to entities. || |
|- |
|- |
||
ā | | |
+ | |block_damage || style="text-align:center"|'''''<Numeric>'''''|| Damage this item deals to blocks; see [[Block Damage]]. || |
|- |
|- |
||
ā | | |
+ | |pa_block_damage || style="text-align:center"|'''''<Numeric>'''''|| Power Attack damage this item deals to blocks. || |
|- |
|- |
||
ā | | |
+ | |range ||style="text-align:center"| '''''<Numeric>'''''|| Maximum range for melee and ranged attacks || |
|- |
|- |
||
ā | | |
+ | |range_effective ||style="text-align:center"| '''''<Numeric>'''''|| For ranged weapons, effective range with full damage. See: [[Range]] || |
|- |
|- |
||
ā | | |
+ | |explosive_radius_entities || style="text-align:center"|'''''<Numeric>'''''|| This is the radius of effect of the explosion as applied to entities. || |
|- |
|- |
||
ā | | |
+ | |explosive_radius_blocks || style="text-align:center"|'''''<Numeric>'''''|| This is the radius of effect of the explosion as applied to blocks. || |
|- |
|- |
||
+ | |attack_rate|| style="text-align:center"|'''''<Numeric>'''''|| Attack rate, units are per minute. || |
||
ā | |heat_map_frequency|| || Frequency in ticks that heat is incremented. Applies only to blocks (found in blocks.xml) || |
||
|- |
|- |
||
+ | |round_rate|| style="text-align:center"|'''''<Numeric>'''''|| Round rate, units are per minute. || |
||
ā | |inv_slots|| || || |
||
|- |
|- |
||
ā | | |
+ | |reload_speed ||style="text-align:center"| '''''<Numeric>'''''|| Time it takes to reload item || |
|- |
|- |
||
+ | |mag || style="text-align:center" | '''''<Numeric>''''' || Magazine Size|| |
||
ā | |price_base|| ||Default Value of an item || |
||
|- |
|- |
||
+ | |ammo || style="text-align:center" | '''''<Numeric>''''' || The item this item uses as ammo. || |
||
ā | |perk_modified|| ||Perks that modify the values of this item. Can be found in items.xml (<property name="Tags")|| |
||
|- |
|- |
||
ā | | |
+ | |stamina_usage || style="text-align:center" | '''''<Numeric>''''' || How much stamina this item uses. || |
|- |
|- |
||
ā | | |
+ | |pa_stamina_usage || style="text-align:center" | '''''<Numeric>''''' || How much stamina this item uses on power attacks. || |
|- |
|- |
||
ā | | |
+ | |durability_min ||style="text-align:center"|'''''<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 ||style="text-align:center"|'''''<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 ||style="text-align:center"|'''''<Numeric>''''' || The rate at which the durability decreases per use when the item is used. || |
|- |
|- |
||
ā | | |
+ | |bonus_damage_earth|| style="text-align:center"|'''''<Numeric>''''' || Bonus damage to this type of item, expressed as a multiplier || |
|- |
|- |
||
ā | | |
+ | |bonus_damage_metal|| style="text-align:center"|'''''<Numeric>''''' || Bonus damage to this type of item, expressed as a multiplier || |
|- |
|- |
||
ā | | |
+ | |bonus_damage_stone|| style="text-align:center"|'''''<Numeric>''''' || Bonus damage to this type of item, expressed as a multiplier || |
|- |
|- |
||
ā | | |
+ | |bonus_damage_wood|| style="text-align:center"|'''''<Numeric>''''' || Bonus damage to this type of item, expressed as a multiplier || |
|- |
|- |
||
ā | | |
+ | |butcher_tool || style="text-align:center"| '''''<Boolean>'''''|| If the item is a butcher tool. || |
|- |
|- |
||
ā | | |
+ | |butcher_damage_multiplier || style="text-align:center"| '''''<Numeric>'''''|| Self-explanatory, usually over 1. || |
|- |
|- |
||
ā | | |
+ | |butcher_resource_multiplier || style="text-align:center"| '''''<Numeric>'''''|| Self-explanatory, between 0 and 1. || |
|- |
|- |
||
ā | | |
+ | |disassemble_tool || style="text-align:center"| '''''<Boolean>'''''|| If the item is a disassemble tool. || |
|- |
|- |
||
ā | | |
+ | |mod_type || style="text-align:center" | '''''<Text>''''' || The mod's type, eg. Barrel Attachment || |
|- |
|- |
||
ā | | |
+ | |mod_compa || style="text-align:center" | '''''<Text>''''' || The mod types this item can have. || |
|- |
|- |
||
ā | + | | colspan="5" style="text-align:center" | <h2> Vehicle Properties Section </h2> |
|
|- |
|- |
||
ā | | |
+ | |vehicle_speed_base||style="text-align:center"| '''''<Numeric>''''' || Base speed of a vehicle || |
|- |
|- |
||
ā | | |
+ | |vehicle_speed_sprint||style="text-align:center"| '''''<Numeric>''''' || Sprint speed of a vehicle || |
|- |
|- |
||
ā | | |
+ | |seats || style="text-align:center" | '''''<Numeric>''''' || The amount of people that can sit in the vehicle at the same time. || |
|- |
|- |
||
ā | | |
+ | | colspan="5" style="text-align:center" | <h2>Protection Properties Section</h2> |
|- |
|- |
||
+ | |hypo-thermal|| style="text-align:center" | '''''<Numeric>''''' || Temperature modifier. This is the how much protection against the cold the item provides. An item can have both hypo and hyper attributes.|| |
||
ā | | colspan="5" style="text-align:center" | <h2>Armor Stats Section</h2> |
||
|- |
|- |
||
ā | | |
+ | |hyper-thermal|| style="text-align:center" | '''''<Numeric>''''' || Temperature modifier. This is the how much protection against heat the item provides. An item can have both hypo and hyper attributes.|| |
|- |
|- |
||
+ | |waterproof|| style="text-align:center" | '''''<Numeric>''''' || How much protection the item provides against water, rain and the like, this will help or hinder with temperature effects. || |
||
ā | |hyper-thermal|| || Temperature modifier. This is the how much protection against heat the item provides. An item can have both hypo and hyper attributes.|| |
||
|- |
|- |
||
+ | |damage_resist || style="text-align:center" | '''''<Numeric>''''' || The basic armor rating of the armor. || |
||
ā | |waterproof|| || How much protection the item provides against water, rain and the like, this will help or hinder with temperature effects. || |
||
|- |
|- |
||
ā | | |
+ | |mobility || style="text-align:center" | '''''<Numeric>''''' || What effect the armor has in mobility, eg. -4.1%. || |
|- |
|- |
||
+ | |sta_regen || style="text-align:center" | '''''<Numeric>''''' || How much the item reduces stamina regeneration ''while running'', eg. the bigger number that is shown in-game too. For example -1.5% || |
||
ā | |hunger || || Fullness change when you eat/drink this one. || |
||
|- |
|- |
||
+ | |noise || style="text-align:center" | '''''<Numeric>''''' || How much the item increases the player's noise eg. 20% || |
||
ā | |thirst || || Thirst change when you eat/drink this one. || |
||
|- |
|- |
||
+ | | colspan="5" style="text-align:center" | <h2>Consumption Effects Section</h2> |
||
ā | |health || || Health change when you eat/drink this one. || |
||
|- |
|- |
||
ā | | |
+ | |food || style="text-align:center" | '''''<Numeric>''''' || Fullness change when you eat/drink this one. || |
|- |
|- |
||
ā | | |
+ | |water || style="text-align:center" | '''''<Numeric>''''' || Thirst change when you eat/drink this one. || |
|- |
|- |
||
ā | | |
+ | |stamina || style="text-align:center" | '''''<Numeric>''''' || Stamina change when you eat/drink this one. || |
|- |
|- |
||
ā | | |
+ | |health || style="text-align:center" | '''''<Numeric>''''' || Health change when you eat/drink this one. || |
|- |
|- |
||
ā | | |
+ | |health_max || style="text-align:center" | '''''<Numeric>''''' || Change to max health when you eat/drink/use this one - Integrated Survival System. || |
|- |
|- |
||
ā | | |
+ | |buff|| style="text-align:center" | '''''<Text>''''' || Other buffs when you eat/drink this one. || |
|- |
|- |
||
ā | | |
+ | |buff_chance || style="text-align:center" | '''''<Numeric>''''' || The chance to obtain said buff. || |
|- |
|- |
||
ā | | |
+ | |buff_effect || style="text-align:center" | '''''<Text>''''' || What the buff does. || |
|- |
|- |
||
ā | | |
+ | |dysentery_chance || style="text-align:center" | '''''<Numeric>''''' || The chance to obtain dysentery. || |
|- |
|- |
||
ā | | |
+ | | colspan="5" style="text-align:center" | <h2> Characteristic Properties Section</h2> |
|- |
|- |
||
ā | | |
+ | |repair || style="text-align:center" | '''''<Text>''''' || The item that is needed to repair this one. || |
|- |
|- |
||
ā | | |
+ | |power_required || style="text-align:center"| '''''<Numeric>''''' || The value given is the amount of power required to run this device. || |
|- |
|- |
||
ā | | |
+ | |unlocks|| style="text-align:center" | '''''<Text>''''' || The item this one unlocks (if any). || |
|- |
|- |
||
+ | |price_base|| ||Default Value of an item || |
||
ā | |range_repair ||style="text-align:center"| '''''<Numeric>'''''|| For repair tools, the maximum repair/upgrade range of the tool. See: [[Range]] || |
||
|- |
|- |
||
ā | | |
+ | |stack || style="text-align:center"|'''''<Numeric>'''''|| Maximum amount of items in one stack || |
|- |
|- |
||
+ | | colspan="5" style="text-align:center" | <h2>Scrapping/Forging Properties Section</h2> |
||
ā | |ammo || || The item this item uses as ammo (if any) || |
||
|- |
|- |
||
+ | |scrappable|| style="text-align:center" | '''''<Boolean>''''' || Whether or not the item can be scrapped. || |
||
ā | |mag || || Capacity || |
||
|- |
|- |
||
ā | | |
+ | |breaks|| style="text-align:center" | '''''<Text>''''' || The material got when scrapping this item. || |
ā | * 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. | |
||
|- |
|- |
||
ā | | |
+ | |meltable|| style="text-align:center" | '''''<Boolean>''''' || Whether or not the item can be melted in forge. || |
|- |
|- |
||
|metal || |
|metal || |
||
Line 421: | Line 379: | ||
*Stone |
*Stone |
||
*Clay |
*Clay |
||
ā | ||The kind of metal this item gives when melted || |
+ | ||The kind of metal this item gives when melted. || |
ā | |- |
||
ā | |weight_forge || || How much 'metal' this item gives when melted || |
||
ā | |- |
||
ā | |burn-time || || amount of time the item burns (in secs) || |
||
ā | |- |
||
ā | |provides_power || style="text-align:center"|'''''<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.| |
||
ā | |- |
||
ā | | colspan="5" style="text-align:center" | <h2>Other Uses Section</h2> |
||
ā | |- |
||
ā | |unlocks|| || The item this one unlocks (if any) || |
||
ā | |- |
||
ā | |used_by || || || |
||
ā | |- |
||
ā | |upgradesInto|| || Upgrades into || |
||
ā | |- |
||
ā | |used_in || || Items you can craft with this one. || |
||
ā | |- |
||
ā | |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.|| |
||
ā | |- |
||
ā | | colspan="5" style="text-align:center" | <h2>Crafting Section</h2> |
||
ā | |- |
||
ā | |unlocked || || The perk that unlocks this. Can be found in recipies.xml(<recipe tags="'''HERE'''")|| |
||
ā | |- |
||
ā | |schematic_name || || item unlocked through schematic name || |
||
ā | |- |
||
ā | |used_ingredients || || Ingredients used to cook this one. || |
||
ā | |- |
||
ā | |repair || || The item that is needed to repair this one || |
||
ā | |- |
||
ā | |scrap_additional || || Additional non-listed scrap result this item gives when scrapped || style="text-align:center"|Y |
||
ā | |- |
||
ā | |scrap_brass|| ||How much [[Brass]] this item gives when scrapped || style="text-align:center"|Y |
||
ā | |- |
||
ā | |scrap_cloth|| ||How much [[Cloth]] this item gives when scrapped || style="text-align:center"|Y |
||
ā | |- |
||
ā | |scrap_electricalParts|| ||How much [[Electrical Parts]] this item gives when scrapped ||style="text-align:center"| Y |
||
ā | |- |
||
ā | |scrap_glass|| ||How much [[Glass]] this item gives when scrapped || style="text-align:center"|Y |
||
ā | |- |
||
ā | |scrap_iron || ||How much [[Iron]] this item gives when scrapped || style="text-align:center"|Y |
||
ā | |- |
||
ā | |scrap_lead|| ||How much [[Lead]] this item gives when scraped || style="text-align:center"|Y |
||
ā | |- |
||
ā | |scrap_leather|| ||How much [[Leather]] this item gives when scraped || style="text-align:center"|Y |
||
ā | |- |
||
ā | |scrap_mechanicalParts|| || How much [[Mechanical Parts]] this item gives when scrapped || style="text-align:center"|Y |
||
ā | |- |
||
ā | |scrap_militaryfiber|| || How much [[Military Fiber]] this item gives when scrapped || style="text-align:center"|Y |
||
ā | |- |
||
ā | |scrap_paper|| ||How much [[Paper]] this item gives when scrapped || style="text-align:center"|Y |
||
ā | |- |
||
ā | |scrap_plantfiber|| || How much [[Plant Fibers]] this item gives when scrapped || style="text-align:center"|Y |
||
ā | |- |
||
ā | |scrap_polymers|| || How much [[Scrap Polymers]] this item gives when scrapped ||style="text-align:center"| Y |
||
ā | |- |
||
ā | |scrap_stone|| || How much [[Small Stones]] this item gives when scrapped ||style="text-align:center"| Y |
||
ā | |- |
||
ā | |scrap_tungsten|| ||How much [[Scrap Tungsten]] this item gives when scrapped || style="text-align:center"|Y |
||
ā | |- |
||
ā | |scrap_wood|| ||How much [[Wood]] this item gives when scrapped || style="text-align:center"|Y |
||
ā | |- |
||
ā | |breaks|| ||Breaks into which items|| |
||
ā | |- |
||
ā | | colspan="5" style="text-align:center" | <h2>Farming Section</h2> |
||
ā | |- |
||
ā | |Empty| || || |
||
ā | |- |
||
ā | | colspan="5" style="text-align:center" | <h2>Obtained Section</h2> |
||
ā | |- |
||
ā | |ob_cheat || || whether the item is obtainable through creative menu || style="text-align:center"|Y |
||
ā | |- |
||
ā | |ob_cook || || whether the item is obtainable through cooking || style="text-align:center"|Y |
||
ā | |- |
||
ā | |ob_craft || || whether the item is obtainable through crafting || style="text-align:center"|Y |
||
ā | |- |
||
ā | |ob_dismantle || || whether the item is obtainable through dismantling || style="text-align:center"|Y |
||
ā | |- |
||
ā | |ob_farm || || whether the item is obtainable through farming || style="text-align:center"|Y |
||
|- |
|- |
||
+ | |fuel|| style="text-align:center" | '''''<Boolean>''''' || Whether or not the item can be used as fuel in campfire/forge etc. || |
||
ā | |ob_forge || || whether the item is obtainable through forging || style="text-align:center"|Y |
||
|- |
|- |
||
+ | |burn-time || style="text-align:center" | '''''<Numeric>''''' || amount of time the item burns (in seconds). || |
||
ā | |ob_loot || || whether the item is obtainable through looting || style="text-align:center"|Y |
||
|- |
|- |
||
ā | | |
+ | | colspan="5" style="text-align:center" | <h2> Farming Properties Section</h2> |
|- |
|- |
||
+ | |crop || style="text-align:center" | '''''<Text>''''' || The item that can be harvested from the plant this seed grows. || |
||
ā | |ob_scavenge || || whether the item is obtainable through scavenging || style="text-align:center"|Y |
||
|- |
|- |
||
+ | |seed || style="text-align:center" | '''''<Text>''''' || The seed that can be planted to get this crop. || |
||
ā | |ob_scrap || || whether the item is obtainable through scrapping || style="text-align:center"|Y |
||
|- |
|- |
||
+ | |grow-time|| style="text-align:center" | '''''<Numeric>''''' || The time this seed needs to grow to be harvestable.|| |
||
ā | |ob_upgrade || || whether the item is obtainable through upgrading || style="text-align:center"|Y |
||
|- |
|- |
||
+ | | colspan="5" style="text-align:center" | <h2>Obtaining Section</h2> |
||
ā | |ob_schematic || || whether the item is learn-able through schematic || style="test-align:center"|Y |
||
|- |
|- |
||
+ | |obtain || |
||
+ | *Cooking |
||
+ | *Crafting |
||
+ | *Farming |
||
+ | *Forging |
||
+ | *Looting |
||
+ | *Mining |
||
+ | *Scrapping |
||
+ | *Upgrading |
||
+ | *Trading |
||
+ | || How this item can be obtained.|| |
||
|} |
|} |
||
Revision as of 18:35, 2 February 2021
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 = |image = |caption = |image_alt1 = |caption_alt1 = |image_alt2 = |caption_alt2 = |size = |group = |category = |type = |loot_cont = |slot = |attribute_focus = |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 = |noise = |food = |water = |stamina = |health = |health_max = |cures = |buff = |buff_chance = |buff_effect = |dysentery_chance = |repair = |power_required = |unlocks = |price_base = |stack = |scrappable = |breaks= |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 | The group this item belongs to. (For possible groups see: Item Group) Can be more than one. |
Y | Y | |
category |
|
The wiki category/categories in which to place the item. | 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 |
|
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. | ||
dysentery_chance | <Numeric> | The chance to obtain dysentery. | ||
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. | ||
meltable | <Boolean> | Whether or not the item can be melted in forge. | ||
metal |
|
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 |
|
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.