Template:Infobox item/doc: Difference between revisions
m (→Parameters) |
m (Undo) Tag: Undo |
||
(107 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} | |||
{{Note|type=warn|content=<u>'''IMPORTANT:'''</u> This template has recently undergone a '''''major''''' rework. Please use this template with caution until all testing is completed.}} | |||
All item infoboxes use this template. | All item infoboxes use this template. | ||
== | {{toc|left}} | ||
==Basic usage== | |||
{{Infobox item | |||
|name=name | |||
|model=image.png | |||
|model_caption=model_caption | |||
|icon=Image.png | |||
|icon_name=icon_name | |||
|category=category | |||
|weight=weight | |||
|item_id=item_id | |||
}} | |||
<pre>{{Infobox item | |||
|name= | |||
|model= | |||
|icon= | |||
|icon_name= | |||
|category= | |||
|weight= | |||
|item_id= | |||
}}</pre>{{Clear}} | |||
==Detailed usage== | |||
===Weapon=== | |||
<syntaxhighlight lang="html">{{Infobox item | |||
|name= | |||
|model= | |||
|icon= <!-- icon2, icon3, ... --> | |||
|icon_name= <!-- icon_name2, icon_name3, ... --> | |||
<!--General--> | |||
|category= | |||
|weight= | |||
|equipped= | |||
|attachment_type= | |||
|function= | |||
|skill_type= | |||
|ammo_type= | |||
|clip_size= | |||
<!--Properties--> | |||
|material= <!-- E.g., Metal --> | |||
|material_value= <!-- E.g., MetalValue attribute --> | |||
|condition_max= | |||
|condition_lower_chance= | |||
|attack_speed= | |||
<!--Performance--> | |||
|damage_type= | |||
|min_damage= | |||
|max_damage= | |||
|door_damage= | |||
|tree_damage= | |||
|min_range= | |||
|max_range= | |||
|sound_radius= | |||
|base_speed= | |||
|push_back= | |||
|aiming_time= | |||
|reload_time= | |||
|crit_chance= | |||
|crit_multiplier= | |||
|kill_move= | |||
<!--Technical--> | |||
|tag= | |||
|item_id= | |||
}}</syntaxhighlight> | |||
===Weapon part=== | |||
<syntaxhighlight lang="html">{{Infobox item | |||
|name= | |||
|model= | |||
|icon= <!-- icon2, icon3, ... --> | |||
|icon_name= <!-- icon_name2, icon_name3, ... --> | |||
<!--General--> | |||
|category= | |||
|weight= | |||
|part_type= | |||
|function= | |||
|weapon= | |||
|ammo_type= | |||
|clip_size= | |||
<!--Properties--> | |||
|material= <!-- E.g., Metal --> | |||
|material_value= <!-- E.g., MetalValue attribute --> | |||
<!--Performance--> | |||
|damage_mod= | |||
|min_range_mod= | |||
|max_range_mod= | |||
|recoil_delay= | |||
|sound_radius= | |||
|aiming_time= | |||
|reload_time= | |||
|angle_mod= | |||
|weight_mod= | |||
<!--Crafting--> | |||
|workspace= | |||
|tool= | |||
|ingredients= | |||
<!--Technical--> | |||
|tag= | |||
|item_id= | |||
}}</syntaxhighlight> | |||
===Ammo=== | |||
<syntaxhighlight lang="html">{{Infobox item | |||
|name= | |||
|model= | |||
|model2= | |||
|icon= | |||
|icon_name= | |||
|icon2= | |||
|icon_name2= | |||
<!--General--> | |||
|category=Ammo | |||
|weight= | |||
|weight_text=(single) | |||
|weight2= | |||
|weight_text2=(box) | |||
|weapon= | |||
<!--Properties--> | |||
|material= | |||
|material_value= | |||
|capacity= | |||
<!--Crafting--> | |||
|workspace= | |||
|tool= | |||
|ingredients= | |||
<!--Technical--> | |||
|tag= | |||
|item_id= | |||
}}</syntaxhighlight> | |||
===Clothing=== | |||
<syntaxhighlight lang="html">{{Infobox item | |||
|name= | |||
|model= | |||
|icon= <!-- icon2, icon3, ... --> | |||
|icon_name= <!-- icon_name2, icon_name3, ... --> | |||
<!--General--> | |||
|category= | |||
|weight= | |||
|capacity= | |||
|weight_reduction= | |||
|body_location= | |||
|function= | |||
|attachments_provided | |||
<!--Properties--> | |||
|material= <!-- E.g., FabricType attribute --> | |||
|condition_max= | |||
|condition_lower_chance= | |||
|run_speed= | |||
|combat_speed= | |||
|scratch_defense= | |||
|bite_defense= | |||
|bullet_defense= | |||
|neck_protection= | |||
|insulation= | |||
|wind_resistance= | |||
|water_resistance= | |||
<!--Technical--> | |||
|tag= | |||
|item_id= | |||
}}</syntaxhighlight> | |||
===Bag=== | |||
<syntaxhighlight lang="html">{{Infobox item | |||
|name= | |||
|model= | |||
|icon= <!-- icon2, icon3, ... --> | |||
|icon_name= <!-- icon_name2, icon_name3, ... --> | |||
<!--General--> | |||
|category= | |||
|weight= | |||
|capacity= | |||
|weight_reduction= | |||
|equipped= <!-- E.g., CanBeEquipped attribute --> | |||
|function= | |||
<!--Properties--> | |||
|material= <!-- E.g., FabricType attribute --> | |||
|weight_reduction= | |||
|run_speed= | |||
|combat_speed= | |||
<!--Technical--> | |||
|tag= | |||
|item_id= | |||
}} | |||
</syntaxhighlight> | |||
===Medical=== | |||
<syntaxhighlight lang="html"> | |||
{{Infobox item | |||
|name= | |||
|model= | |||
|icon= <!-- icon2, icon3, ... --> | |||
|icon_name= <!-- icon_name2, icon_name3, ... --> | |||
<!--General--> | |||
|category= | |||
|weight= | |||
|function= | |||
|max_units= | |||
<!--Nutrition--> | |||
|hunger_change= | |||
|calories= | |||
<!--Properties--> | |||
|material= <!-- or |metal_value= --> | |||
|material_value= <!-- or |metal_value= --> | |||
|max_units= <!-- Do not add again if already defined in General section --> | |||
<!--Effect--> | |||
|unhappy_change= | |||
|boredom_change= | |||
|stress_change= | |||
|fatigue_change= | |||
|endurance_change= | |||
|flu_change= | |||
|pain_change= | |||
|sick_change= | |||
|reduce_infection_power= | |||
|alcohol_power= | |||
|wet_cooldown= | |||
|bandage_power= | |||
<!--Crafting--> | |||
|workspace= | |||
|tool= | |||
|ingredients= | |||
<!--Technical--> | |||
|tag= | |||
|item_id= | |||
}} | |||
</syntaxhighlight> | |||
===Water container=== | |||
<syntaxhighlight lang="html">{{Infobox item | |||
|name= | |||
|model= | |||
|icon= | |||
|icon_name= | |||
<!--General--> | |||
|category= | |||
|weight= | |||
|weight_full= | |||
|function= | |||
<!--Properties--> | |||
|max_units= | |||
|contents= | |||
|can_boil_water= | |||
|rain_factor= | |||
|material= <!-- or |metal_value= --> | |||
|material_value= <!-- or |metal_value= --> | |||
<!--Technical--> | |||
|tag= | |||
|item_id= | |||
}} | |||
</syntaxhighlight> | |||
===Communication=== | |||
<syntaxhighlight lang="html">{{Infobox item | |||
|name= | |||
|model= | |||
|icon= <!-- icon2, icon3, ... --> | |||
|icon_name= <!-- icon_name2, icon_name3, ... --> | |||
<!--General--> | |||
|category= | |||
|weight= | |||
|function= | |||
<!--Properties--> | |||
|material= | |||
|material_value= | |||
|weight_reduction= | |||
|condition_max= | |||
|condition_lower_chance= | |||
|energy_source= | |||
|portable= | |||
|two_way= | |||
|mic_range= | |||
|transmit_range= | |||
|min_channel= | |||
|max_channel= | |||
<!--Performance--> | |||
|sound_radius= | |||
<!--Crafting--> | |||
|workspace= | |||
|tool= | |||
|ingredients= | |||
<!--Technical--> | |||
|tags= | |||
|item_id= | |||
}}</syntaxhighlight> | |||
===Food=== | |||
<syntaxhighlight lang="text"> | |||
{{Infobox item | {{Infobox item | ||
| name = | |name= | ||
| | |model= | ||
| | |icon= <!-- icon2, icon3, ... --> | ||
| | |icon_name= <!-- icon_name2, icon_name3, ... --> | ||
| | <!--General--> | ||
| | |category= | ||
| | |weight= | ||
| | |function= | ||
| | |max_units= | ||
| | |days_fresh= | ||
| | |days_rotten= | ||
|cant_be_frozen= | |||
| | |packaged= | ||
| | <!--Nutrition--> | ||
| | |hunger_change= | ||
| | |thirst_change= | ||
| | |calories= | ||
| | |lipids= | ||
| | |proteins= | ||
| | |carbohydrates= | ||
| | <!--Effect--> | ||
| | |unhappy_change= | ||
| | |boredom_change= | ||
}}</ | |stress_change= | ||
|fatigue_change= | |||
|endurance_change= | |||
|flu_change= | |||
|pain_change= | |||
|sick_change= | |||
|reduce_infection_power= | |||
|alcohol_power= | |||
|poison_power= | |||
<!--Cooking--> | |||
|cook_minutes= | |||
|burn_minutes= | |||
|dangerous_uncooked= | |||
|bad_microwaved= | |||
|good_hot= | |||
|bad_cold= | |||
|spice= | |||
|evolved_recipe= | |||
<!--Crafting--> | |||
|workspace= | |||
|tool= | |||
|ingredients= | |||
<!--Technical--> | |||
|tag= | |||
|item_id= | |||
}} | |||
</syntaxhighlight> | |||
===Literature=== | |||
<syntaxhighlight lang="html">{{Infobox item | |||
|name= | |||
|model= | |||
|icon= <!-- icon2, icon3, ... --> | |||
|icon_name= <!-- icon_name2, icon_name3, ... --> | |||
<!--General--> | |||
|category= | |||
|weight= | |||
|function= | |||
<!--Properties--> | |||
|consumed= | |||
|writable= | |||
|recipes= | |||
|page_number= | |||
|vol_number= | |||
<!--Effect--> | |||
|unhappy_change= | |||
|boredom_change= | |||
|stress_change= | |||
<!--Technical--> | |||
|tag= | |||
|item_id= | |||
}}</syntaxhighlight> | |||
===Light source=== | |||
<syntaxhighlight lang="html">{{Infobox item | |||
|name= | |||
|model= | |||
|icon= | |||
|icon_name= | |||
<!--General--> | |||
|category= | |||
|weight= | |||
|function= | |||
<!--Properties--> | |||
|material= <!-- or |metal_value= --> | |||
|material_value= <!-- or |metal_value= --> | |||
|max_units= | |||
|light_distance= | |||
|light_strength= | |||
|torch_cone= | |||
|energy_source= | |||
<!--Technical--> | |||
|tag= | |||
|item_id= | |||
}}</syntaxhighlight> | |||
===Media=== | |||
<syntaxhighlight lang="html">{{Infobox item | |||
|name= | |||
|model= | |||
|icon= | |||
|icon_name= | |||
<!--General--> | |||
|category= | |||
|weight= | |||
<!--Properties--> | |||
|skill_trained= | |||
<!--EFFECT--> | |||
|unhappy_change= | |||
|boredom_change= | |||
|stress_change= | |||
|panic_change= | |||
|fatigue_change= | |||
|endurance_change= | |||
|fitness_change=<!--currently unused--> | |||
|drunk_change=<!--currently unused--> | |||
|anger_change=<!--currently unused--> | |||
|morale_change=<!--currently unused--> | |||
|fear_change=<!--currently unused--> | |||
<!--Technical--> | |||
|item_id= | |||
|media_id= | |||
}}</syntaxhighlight> | |||
===Other=== | |||
<syntaxhighlight lang="html">{{Infobox item | |||
|name= | |||
|model= | |||
|icon= | |||
|icon_name= | |||
<!--General--> | |||
|category= | |||
|weight= | |||
|function= | |||
<!--Properties--> | |||
|material= <!-- or |metal_value= --> | |||
|material_value= <!-- or |metal_value= --> | |||
|max_units= | |||
<!--Crafting--> | |||
|workspace= | |||
|tool= | |||
|ingredients= | |||
<!--Technical--> | |||
|tag= | |||
|item_id= | |||
}}</syntaxhighlight> | |||
==Parameters== | ==Parameters== | ||
Any of the following parameters can be used in the template, regardless of whether or not they're included in the above examples. | |||
{{Infobox item | {{Infobox item | ||
| name = | |name = name | ||
| | |icon = Image.png |icon2 = Image.png |icon3 = Image.png |icon4 = Image.png |icon5 = Image.png |icon6 = Image.png |icon7 = Image.png | ||
| | |icon8 = Image.png |icon9 = Image.png |icon10 = Image.png |icon11 = Image.png |icon12 = Image.png |icon13 = Image.png |icon14 = Image.png | ||
| image = | |icon15 = Image.png |icon16 = Image.png |icon17 = Image.png |icon18 = Image.png |icon19 = Image.png |icon20 = Image.png |icon21 = Image.png | ||
| image_width = | <!-- GENERAL --> | ||
| image_caption = | |category = category | ||
| | |weight = weight | ||
| | |weight_full = weight_full | ||
| | |weight_reduction = weight_reduction | ||
| | |max_units = max_units | ||
| | |equipped = equipped | ||
| | |attachment_type = attachment_type | ||
| | |function = function | ||
| | |weapon = weapon | ||
| | |part_type = part_type | ||
| | |skill_type = skill_type | ||
| | |ammo_type = ammo_type | ||
| | |clip_size = clip_size | ||
| | <!-- PROPERTIES --> | ||
| | |material = material | ||
| | |material_value = material_value | ||
| weight = | |contents = contents | ||
| | <!--|max_units = capacity--> | ||
| | <!--|weight_reduction = weight_reduction--> | ||
| | |can_boil_water = can_boil_water | ||
| | |consumed = consumed | ||
| | |writable = writable | ||
| | |recipes = recipes | ||
| | |page_number = page_number | ||
| | |vol_number = vol_number | ||
| | |packaged = packaged | ||
| | |rain_factor = rain_factor | ||
| | |days_fresh = days_fresh | ||
| | |days_rotten = days_rotten | ||
| | |cant_be_frozen = cant_be_frozen | ||
| | |condition_max = condition_max | ||
| | |condition_lower_chance = 1 | ||
| | |run_speed = run_speed | ||
| | |combat_speed = combat_speed | ||
| | |scratch_defense = scratch_defense | ||
| | |bite_defense = bite_defense | ||
| | |bullet_defense = bullet_defense | ||
| | |neck_protection = neck_protection | ||
| | |insulation = insulation | ||
| | |wind_resistance = wind_resistance | ||
| | |water_resistance = water_resistance | ||
| | |light_distance = light_distance | ||
| | |light_strength = light_strength | ||
| | |torch_cone = torch_cone | ||
| | |wet_cooldown = wet_cooldown | ||
| | |sensor_range = sensor_range | ||
| | |energy_source = energy_source | ||
| | |two_way = two_way | ||
| | |mic_range = mic_range | ||
| | |transmit_range = transmit_range | ||
| | |min_channel = min_channel | ||
| | |max_channel = max_channel | ||
| | <!-- PERFORMANCE --> | ||
| | |damage_type = slash | ||
| | <!--|damage_mod = damage_mod--> | ||
| | |min_damage = min_damage | ||
| | |max_damage = max_damage | ||
| | |door_damage = door_damage | ||
| | |tree_damage = tree_damage | ||
| | |min_range = min_range | ||
| | |max_range = max_range | ||
| | |min_range_mod = min_range_mod | ||
| | |max_range_mod = max_range_mod | ||
| | |hit_chance = hit_chance | ||
| | |recoil_delay = recoil_delay | ||
| | |sound_radius = sound_radius | ||
| | |base_speed = base_speed | ||
| | |push_back = push_back | ||
| | |knockdown = knockdown | ||
| | |aiming_time = aiming_time | ||
| | |reload_time = reload_time | ||
| | |crit_chance = crit_chance | ||
| | |crit_multiplier = crit_multiplier | ||
| | |angle_mod = angle_mod | ||
|kill_move = kill_move | |||
|weight_mod = weight_mod | |||
|effect_type = effect_type | |||
|effect_power = effect_power | |||
|effect_range = effect_range | |||
|effect_duration = effect_duration | |||
|effect_timer = effect_timer | |||
<!-- PERFORMANCE --> | |||
|hunger_change = hunger_change | |||
|thirst_change = thirst_change | |||
|calories = calories | |||
|carbohydrates = carbohydrates | |||
|proteins = proteins | |||
|lipids = lipids | |||
<!-- EFFECT --> | |||
|unhappy_change = unhappy_change | |||
|boredom_change = boredom_change | |||
|stress_change = stress_change | |||
|panic_change = panic_change | |||
|fatigue_change = fatigue_change | |||
|endurance_change = endurance_change | |||
|flu_change = flu_change | |||
|pain_change = pain_change | |||
|sick_change = sick_change | |||
|alcoholic = alcoholic | |||
|alcohol_power = alcohol_power | |||
|reduce_infection_power = reduce_infection_power | |||
|bandage_power = bandage_power | |||
<!--|wet_cooldown = wet_cooldown--> | |||
<!--|max_units = max_units--> | |||
|poison_power = poison_power | |||
<!-- COOKING --> | |||
|cook_minutes = cook_minutes | |||
|burn_minutes = burn_minutes | |||
|dangerous_uncooked = dangerous_uncooked | |||
|bad_microwaved = bad_microwaved | |||
|good_hot = good_hot | |||
|bad_cold = bad_cold | |||
|spice = spice | |||
|evolved_recipe = evolved_recipe | |||
<!-- CRAFTING --> | |||
|workstation = workstation | |||
|tool = tool | |||
|ingredients = ingredients | |||
<!-- TECHNICAL --> | |||
|tags = tags | |||
|item_id = item_id | |||
|guid = guid | |||
|itemdisplayname= | |||
|recmedia= | |||
}} | |||
{| class="wikitable" | |||
| colspan=4 style="background-color: var(--color-red); color: white; text-align: center;" | | |||
===Name and images=== | |||
|- | |||
! colspan="3" | Parameter !! rowspan="2" | Description | |||
|- | |||
! Preferred !! Alternative !! Game files | |||
|- style="vertical-align: top;" | |||
| <code>name</code> || <code>display_name</code> || <code>DisplayName</code> || The name of the item. Displayed at the top of the infobox. Can be different if overwritten by the <code>ItemName_EN.txt</code> file.<br>''Default: uses page name'' | |||
|- style="vertical-align: top;" | |||
| <code>model</code> || <code>image</code> || <code>WorldStaticModel</code><br><code>WeaponSprite</code> || The model of the item. <br>''Default: uses the icon upscaled with pixelated class'' | |||
|- style="vertical-align: top;" | |||
| <s><code>model_width</code></s> || <s><code>image_width</code></s> || || <s>The width of the model. <br>''Default: 200px (128px if <code>model</code> is blank)''</s> | |||
|- style="vertical-align: top;" | |||
| <code>model_caption</code> || <code>image_caption</code> || || The caption of the model/image. Displayed beneath the image/model. | |||
|- style="vertical-align: top;" | |||
| <code>icon</code> || || <code>Icon</code><br><code>IconsForTexture</code> || The icon of the item. For multiple icons, add any number from 2-16 to the parameter. <br>''E.g., <code>icon2</code>. '' | |||
|- style="vertical-align: top;" | |||
| <s><code>icon_width</code></s> || || || <s>The width of the icon. For multiple icons, use the same number as the <code>icon</code> parameter. <br>''E.g., <code>icon_width2</code>.''</s> | |||
|- style="vertical-align: top;" | |||
| <code>icon_name</code> || || || The tooltip to be displayed when hovering over the icon. For multiple icons, use the same number as the <code>icon</code> parameter. <br>''E.g., <code>icon_name2</code>.'' | |||
|- style="vertical-align: top;" | |||
| <s><code>icon_link</code></s> || || || <s>The link for the icon when clicked. For multiple icons, use the same number as the <code>icon</code> parameter. <br>''E.g., <code>icon_link2</code>''.</s> | |||
|- style="vertical-align: top;" | |||
| colspan=4 style="background-color: var(--color-red); color: white; text-align: center;" | | |||
===General=== | |||
|- | |||
! colspan="3" | Parameter !! rowspan="2" | Description | |||
|- | |||
! Preferred !! Alternative !! Game files | |||
|- style="vertical-align: top;" | |||
| <code>category</code> || || <code>DisplayCategory</code><br><code>Type</code> || The in-game category for the item. | |||
|- style="vertical-align: top;" | |||
| <code>weight</code> || || <code>Weight</code> || The encumbrance (previously weight) of the item. Up to 3 weights can be defined, by appending a suffix id. E.g., <code>weight2</code>. Encumbrance when equipped will be calculated automatically and added as a tooltip. | |||
|- style="vertical-align: top;" | |||
| <code>weight_text</code> || || || Text to append to the end of the <code>weight</code> value with the same suffix id. E.g., <code>weight_text2</code>. | |||
|- style="vertical-align: top;" | |||
| <code>weight_full</code> || || || The weight of the item when full.<br>Leaving blank will calculate the weight of a bag when full, so long as <code>capacity</code> and <code>weight_reduction</code> are added. Weight organized and disorganized traits will be calculated automatically and added as a tooltip. | |||
|- style="vertical-align: top;" | |||
| <code>capacity</code> || || <code>Capacity</code> || The capacity of the item, to be used in the <code>weight_full</code> value, or displayed in the [[#Properties|properties]] section. \<br>May be for bags or "drainable" items. | |||
|- style="vertical-align: top;" | |||
| <code>weight_reduction</code> || || <code>WeightReduction</code> || The encumbrance reduction of the item. Used in calculating the weight when value. | |||
|- style="vertical-align: top;" | |||
| <code>body_location</code> || <code>equipped</code> || <code>BodyLocation</code><br><code>RequiresEquippedBothHands</code><br><code>TwoHandWeapon</code> || <code>body_location</code> to be used for [[clothing]].<br><code>equipped</code> to be used for other items, like [[weapons]]. | |||
|- style="vertical-align: top;" | |||
| <code>attachment_type</code> || || <code>AttachmentType</code> || The slot the item is attached to. Typically used for weapons. | |||
|- style="vertical-align: top;" | |||
| <s><code>function</code></s> || <s><code>primary_use</code>{{sup|deprecated}}<br><code>secondary_use</code>{{sup|deprecated}}</s> || || <s>The item's function.</s> | |||
|- style="vertical-align: top;" | |||
| <code>secondary_item</code> || || <code>OtherHandRequire</code> || Item to be equipped in the secondary hand for the item to function. | |||
|- style="vertical-align: top;" | |||
| <code>attachments_provided</code> || || <code>AttachmentsProvided</code> || The attachment slots provided by the item. Typical of belts. | |||
|- style="vertical-align: top;" | |||
| <code>weapon</code> || <code>weapons</code>{{sup|deprecated}} || <code>MountOn</code> || Weapons that the item is used in. Multiple weapons can be set by using <code>weapon2</code>, <code>weapon3</code>, etc., up to <code>weapon5</code>.<br>Add a weapon using a wikilink ({{code|[[weapon]]}}) or an image ({{code|[[File:weapon_icon.png|link=weapon]]}}). | |||
|- style="vertical-align: top;" | |||
| <code>part_type</code> || || <code>PartType</code> || Part of the weapon that it is attached to. | |||
|- style="vertical-align: top;" | |||
| <code>skill_type</code> || || <code>Categories</code> || The skill the item is associated with. Typically used with weapons. | |||
|- style="vertical-align: top;" | |||
| <code>ammo_type</code> || <code>ammo</code> || <code>AmmoType</code> || The type of ammo used in the item/firearm. | |||
|- style="vertical-align: top;" | |||
| <code>clip_size</code> || || <code>MaxAmmo</code> || The maximum ammo the item can contain. Typically used for firearms and [[Magazine (firearms)|magazines]]. | |||
|- style="vertical-align: top;" | |||
| colspan=4 style="background-color: var(--color-red); color: white; text-align: center;" | | |||
===Properties=== | |||
|- | |||
! colspan="3" | Parameter !! rowspan="2" | Description | |||
|- | |||
! Preferred !! Alternative !! Game files | |||
|- style="vertical-align: top;" | |||
| <code>material</code> || || <code>FabricType</code><br><code>MetalValue</code> || The material the item is made of. Usage is not strict. Intended use is for items with <code>MetalValue</code>, or <code>FabricType</code> (Cotton, Leather, or Denim). | |||
|- style="vertical-align: top;" | |||
| <code>material_value</code> || || <code>MetalValue</code> || How much of the material the item contains. The <code>material</code> parameter will be included in the group title. | |||
|- style="vertical-align: top;" | |||
| <code>contents</code> || || || Alternate to <code>material</code>, especially if the material is fuzzy, e.g., A water bottle can hold water or gas. | |||
|- style="vertical-align: top;" | |||
| <code>capacity</code>{{sup|container}}<br><code>max_units</code>{{sup|drainable}} || || <code>UseDelta</code>{{sup|drainable}}<br><code>Count</code>{{sup|ammo}} || | |||
'''1)''' <code>max_units</code>: The maximum units of a drainable item. Will automatically be calculated: 1/<code>UseDelta</code>.<br> | |||
'''2)''' <code>capacity</code>{{sup|box}}: Max number of rounds/items in a box. Tooltip will be added to the ''key'' if <code>weight_text2{{=}}(box)</code>.<br> | |||
'''3)''' <code>capacity</code>{{sup|container}}: Storage capacity. Tooltip will be added showing capacity with [[organized]] and [[disorganized]] traits.<br> | |||
'''4)''' If error, it'll display as the input, with no changes. This is in case it's not a valid number or <code>max_units</code> has already been calculated. | |||
|- style="vertical-align: top;" | |||
| <code>weight_reduction</code> || || <code>WeightReduction</code> || Encumbrance reduction of the item. Used to calculate the "Full encumbrance" value. Displayed as a percentage. | |||
|- style="vertical-align: top;" | |||
| <s><code>weight_reduction_text</code></s> || || || <s>Extra text to be displayed next to <code>weight_reduction</code>. Typical usage: <code>(full)</code></s> | |||
|- style="vertical-align: top;" | |||
| <code>can_boil_water</code> || || <code>IsCookable</code><br><code>CanBoilWater</code> || Set to <code>TRUE</code> if the item can be used to boil water. | |||
|- style="vertical-align: top;" | |||
| <code>consumed</code> || || || Set to <code>TRUE</code> if the item is consumed once used/depleted. ''Intended to be used for literature items only. Not to be used for food.'' | |||
|- style="vertical-align: top;" | |||
| <code>writable</code> || || <code>CanBeWrite</code> || Set to <code>TRUE</code> if the item can be written in. | |||
|- style="vertical-align: top;" | |||
| <code>recipes</code> || <code>skill_trained</code> || <code>TeachedRecipes</code><br><code>SkillTrained</code> || The recipes or skills that are learned from the item (magazine or book). | |||
|- style="vertical-align: top;" | |||
| <code>page_number</code> || || <code>NumberOfPages</code><br><code>PageToWrite</code> || Number of pages in the item. | |||
|- style="vertical-align: top;" | |||
| <code>vol_number</code> || || || Number of volumes for the series. | |||
|- style="vertical-align: top;" | |||
| <code>packaged</code> || || <code>Packaged</code> || Set to <code>TRUE</code> if the item is packaged. Unlocks ability to look at the nutritional content. | |||
|- style="vertical-align: top;" | |||
| <code>rain_factor</code> || || <code>RainFactor</code> || Determines how quickly an item can fill up with water if left out in the rain. | |||
|- style="vertical-align: top;" | |||
| <code>days_fresh</code> || || <code>DaysFresh</code> || The amount of days this item is recognized as "fresh". The unit "days" is appended after the value. Chilled and frozen calculated automatically and added as a tooltip. | |||
|- style="vertical-align: top;" | |||
| <code>days_rotten</code> || || <code>DaysTotallyRotten</code> || The amount of days before this item is recognized as "rotten". The unit "days" is appended after the value. Chilled and frozen calculated automatically and added as a tooltip. | |||
|- style="vertical-align: top;" | |||
| <code>cant_be_frozen</code> || || <code>CantBeFrozen</code> || Set to <code>true</code> if the item can be frozen, delaying time before the food rots. Used in calculations for <code>days_fresh</code> and <code>days_rotten</code> tooltip. | |||
|- style="vertical-align: top;" | |||
| <code>condition_max</code> || || <code>ConditionMax</code> || The item's maximum condition, i.e. when it's fully repaired. Used in the calculation for "Base durability" if <code>condition_lower_chance</code> is defined. | |||
|- style="vertical-align: top;" | |||
| <code>condition_lower_chance</code> || || <code>ConditionLowerChanceOneIn</code> || The item's chance of lowering in durability. Used in the calculation for "Base durability". | |||
|- style="vertical-align: top;" | |||
| <s><code>base_durability</code></s> || || <s><code>ConditionMax</code>×<code>ConditionLowerChanceOneIn</code></s> || <s>The average number of hits it will take before breaking, at level 0. See: [[Durability#Base durability]]</s> | |||
|- style="vertical-align: top;" | |||
| <code>run_speed</code> || || <code>RunSpeedModifier</code> || Run speed modifier. Note this is currently bugged/unimplemented, and has no in-game function. | |||
|- style="vertical-align: top;" | |||
| <code>combat_speed</code> || || <code>CombatSpeedModifier</code> || Combat speed modifier for clothing. | |||
|- style="vertical-align: top;" | |||
| <s><code>attack_speed</code></s> || || || | |||
|- style="vertical-align: top;" | |||
| <code>scratch_defense</code> || || <code>ScratchDefense</code> || Scratch defense modifier. Automatically converted to a percentage. | |||
|- style="vertical-align: top;" | |||
| <code>bite_defense</code> || || <code>BiteDefense</code> || Bit defense modifier. Automatically converted to a percentage. | |||
|- style="vertical-align: top;" | |||
| <code>bullet_defense</code> || || <code>BulletDefense</code> || Bullet defense modifier. Automatically converted to a percentage. | |||
|- style="vertical-align: top;" | |||
| <code>neck_protection</code> || || <code>NeckProtectionModifier</code> || Neck protection modifier. Automatically converted to a percentage. | |||
|- style="vertical-align: top;" | |||
| <code>insulation</code> || || <code>Insulation</code> || Insulation modifier. Automatically converted to a percentage. | |||
|- style="vertical-align: top;" | |||
| <code>wind_resistance</code> || || <code>WindResistance</code> || Wind resistance modifier. Automatically converted to a percentage. | |||
|- style="vertical-align: top;" | |||
| <code>water_resistance</code> || || <code>WaterResistance</code> || Water resistance modifier. Automatically converted to a percentage. | |||
|- style="vertical-align: top;" | |||
| <code>light_distance</code> || || <code>LightDistance</code> || The distance the light from the source will travel. | |||
|- style="vertical-align: top;" | |||
| <code>light_strength</code> || || <code>LightStrength</code> || The intensity/brightness of light the source provides. | |||
|- style="vertical-align: top;" | |||
| <code>torch_cone</code> || || <code>TorchCone</code> || Set to <code>TRUE</code> if the light from this item travels in a single direction, a.k.a torch cone. | |||
|- style="vertical-align: top;" | |||
| <code>wet_cooldown</code> || || <code>WetCooldown</code> || Time it takes to dry 1 wet_cooldown unit. Calculated based on the input and displayed in seconds. | |||
|- style="vertical-align: top;" | |||
| <code>sensor_range</code> || <code>remote_range</code> || <code>SensorRange</code><br><code>RemoteRange</code> || How close an entity needs to be before the trap is triggered, or the distance the remote needs to be in order to trigger. | |||
|- style="vertical-align: top;" | |||
| <code>energy_source</code> || || || The energy source of the item. E.g., <code>UsesBattery = TRUE</code> would mean the energy source is a [[battery]]. | |||
|- style="vertical-align: top;" | |||
| <code>portable</code> || || <code>IsPortable</code> || Whether the item can be used while in the inventory, or if it must be placed on the ground in order to operate. | |||
|- style="vertical-align: top;" | |||
| <code>two_way</code> || || <code>TwoWay</code> || Whether the item can receive and transmit a signal. | |||
|- style="vertical-align: top;" | |||
| <code>mic_range</code> || || <code>MicRange</code> || Number of tiles the player must be within in order for the mic to transmit their voice. | |||
|- style="vertical-align: top;" | |||
| <code>transmit_range</code> || || <code>TransmitRange</code> || The distance in tiles the item will transmit | |||
|- style="vertical-align: top;" | |||
| <code>min_channel</code> || || <code>MinChannel</code> || The minimum bandwidth/frequency for selecting a channel. | |||
|- style="vertical-align: top;" | |||
| <code>max_channel</code> || || <code>MaxChannel</code> || The maximum bandwidth/frequency for selecting a channel. | |||
|- style="vertical-align: top;" | |||
| colspan=4 style="background-color: var(--color-red); color: white; text-align: center;" | | |||
===Performance=== | |||
|- | |||
! colspan="3" | Parameter !! rowspan="2" | Description | |||
|- | |||
! Preferred !! Alternative !! Game files | |||
|- style="vertical-align: top;" | |||
| <code>damage_type</code> || || <code>DamageCategory</code> || The type of damage this weapon does. The attribute used to define this has an order of priority if it exists for the item. | |||
#<code>DamageCategory</code> | |||
#<code>SubCategory</code>{{sup|deprecated}} | |||
#<code>Categories</code> (ignore "Improvised") | |||
*Explosives should use common-sense for the damage type, e.g., Fire, Explosion, Smoke, Noise. | |||
|- style="vertical-align: top;" | |||
| <code>min_damage</code> || || <code>MinDamage</code> || Minimal weapon damage, before modifiers. | |||
|- style="vertical-align: top;" | |||
| <code>max_damage</code> || || <code>MaxDamage</code> || Maximum weapon damage, before modifiers. | |||
|- style="vertical-align: top;" | |||
| <code>door_damage</code> || || <code>DoorDamage</code> || Damage modifier done to doors. | |||
|- style="vertical-align: top;" | |||
| <code>tree_damage</code> || || <code>TreeDamage</code> || Damage modifier done to trees. | |||
|- style="vertical-align: top;" | |||
| <code>damage_mod</code> || <code>DamageModifier</code> || || | |||
|- style="vertical-align: top;" | |||
| <code>min_range</code> || || <code>MinRange</code> || Range below which a weapon attack gets converted to shoving. | |||
|- style="vertical-align: top;" | |||
| <code>max_range</code> || || <code>MaxRange</code> || Range at which weapon gets 100% of its damage. | |||
|- style="vertical-align: top;" | |||
| <code>min_range_mod</code> || || || | |||
|- style="vertical-align: top;" | |||
| <code>max_range_mod</code> || <code>hit_chance</code><br><code>hit_chance_mod</code><br><code>accuracy_mod</code> || || | |||
|- style="vertical-align: top;" | |||
| <code>recoil_delay</code> || <code>recoil_mod</code><br><code>recoil_delay_mod</code> || || | |||
|- style="vertical-align: top;" | |||
| <code>sound_radius</code> || || <code>SoundRadius</code> || | |||
|- style="vertical-align: top;" | |||
| <code>base_speed</code> || || <code>BaseSpeed</code><br><code>SwingTime</code> || Base speed of the weapon (previously the <code>SwingTime</code> attribute). | |||
|- style="vertical-align: top;" | |||
| <code>push_back</code> || || <code>PushBackMod</code> || | |||
|- style="vertical-align: top;" | |||
| <s><code>knockdown</code></s> || || <s><code>KnockdownMod</code></s> || <s>Knockdown modifier.{{sup|deprecated}}</s> | |||
|- style="vertical-align: top;" | |||
| <code>aiming_time</code> || <code>aiming_time_mod</code><br><code>aiming_mod</code> || || | |||
|- style="vertical-align: top;" | |||
| <code>reload_time</code> || <code>reload_time_mod</code><br><code>reload_mod</code> || || | |||
|- style="vertical-align: top;" | |||
| <code>crit_chance</code> || || <code>CriticalChance</code> || Base critical chance value, before modifiers. | |||
|- style="vertical-align: top;" | |||
| <code>crit_multiplier</code> || || <code>CritDmgMultiplier</code> || Critical damage multiplier. | |||
|- style="vertical-align: top;" | |||
| <code>angle_mod</code> || <code>spread_mod</code> || || | |||
|- style="vertical-align: top;" | |||
| <code>kill_move</code> || || <code>CloseKillMove</code> || | |||
|- style="vertical-align: top;" | |||
| <code>weight_mod</code> || || || | |||
|- style="vertical-align: top;" | |||
| <code>effect_type</code> || || || | |||
|- style="vertical-align: top;" | |||
| <code>effect_power</code> || || || | |||
|- style="vertical-align: top;" | |||
| <code>effect_range</code> || || || | |||
|- style="vertical-align: top;" | |||
| <code>effect_duration</code> || || || | |||
|- style="vertical-align: top;" | |||
| <code>effect_timer</code> || || || | |||
|- style="vertical-align: top;" | |||
| colspan=4 style="background-color: var(--color-red); color: white; text-align: center;" | | |||
===Nutrition=== | |||
|- | |||
! colspan="3" | Parameter !! rowspan="2" | Description | |||
|- | |||
! Preferred !! Alternative !! Game files | |||
|- style="vertical-align: top;" | |||
| <code>hunger_change</code> || || <code>HungerChange</code><br><code>HUN</code> || The value of hunger that is changed from using/consuming this item. | |||
|- style="vertical-align: top;" | |||
| <code>thirst_change</code> || || <code>ThirstChange</code><br><code>THI</code> || The value of thirst that is changed from using/consuming this item. | |||
|- style="vertical-align: top;" | |||
| <code>calories</code> || || <code>Calories</code> || The value of calories. | |||
|- style="vertical-align: top;" | |||
| <code>carbohydrates</code> || || <code>Carbohydrates</code> || The value of carbohydrates. | |||
|- style="vertical-align: top;" | |||
| <code>proteins</code> || || <code>Proteins</code> || The value of proteins. | |||
|- style="vertical-align: top;" | |||
| <code>lipids</code> || <code>fat</code> || <code>Lipids</code> || The value of lipids. | |||
|- style="vertical-align: top;" | |||
| colspan=4 style="background-color: var(--color-red); color: white; text-align: center;" | | |||
===Effect=== | |||
|- | |||
! colspan="3" | Parameter !! rowspan="2" | Description | |||
|- | |||
! Preferred !! Alternative !! Game files | |||
|- style="vertical-align: top;" | |||
| <code>unhappy_change</code> || || <code>UnhappyChange</code><br><code>UHP</code> || The value of unhappiness that is changed from using/consuming this item. | |||
|- style="vertical-align: top;" | |||
| <code>boredom_change</code> || || <code>BoredomChange</code><br><code>BOR</code> || The value of boredom that is changed from using/consuming this item. | |||
|- style="vertical-align: top;" | |||
| <code>stress_change</code> || || <code>StressChange</code><br><code>STS</code> || The value of stress that is changed from using/consuming this item. | |||
|- style="vertical-align: top;" | |||
| <code>panic_change</code> || || <code>PAN</code> || The value of panic that is changed from using/consuming this item. | |||
|- style="vertical-align: top;" | |||
| <code>fatigue_change</code> || || <code>FatigueChange</code><br><code>FAT</code> || The value of fatigue that is changed from using/consuming this item. | |||
|- style="vertical-align: top;" | |||
| <code>endurance_change</code> || || <code>EnduranceChange</code><br><code>END</code> || The value of endurance that is changed from using/consuming this item. | |||
|- style="vertical-align: top;" | |||
| <code>flu_change</code> || || <code>FluReduction</code> || The value of flu/cold that is changed from using/consuming this item. | |||
|- style="vertical-align: top;" | |||
| <code>pain_change</code> || || <code>PainReduction</code><br><code>PAI</code> || The value of pain that is changed from using/consuming this item. | |||
|- style="vertical-align: top;" | |||
| <code>sick_change</code> || || <code>ReduceFoodSickness</code><br><code>SIC</code> || The value of sickness that is changed from using/consuming this item. | |||
|- style="vertical-align: top;" | |||
| <code>alcoholic</code> || <code>alcohol</code> || <code>Alcoholic</code><br><code>DRU</code> || Whether this item is considered to be alcohol and therefore contributing to the [[drunk]] moodle. | |||
|- style="vertical-align: top;" | |||
| <code>alcohol_power</code> || || <code>AlcoholPower</code> || The alcohol power of this item when used on wounds. | |||
|- style="vertical-align: top;" | |||
| <code>reduce_infection_power</code> || || <code>ReduceInfectionPower</code> || How much the item reduces wound infection. | |||
|- style="vertical-align: top;" | |||
| <code>bandage_power</code> || || <code>BandagePower</code> || How effective the item is at absorbing blood, and how frequently it needs to be replaced. | |||
|- style="vertical-align: top;" | |||
| <code>wet_cooldown</code> || || <code>WetCooldown</code> || If this value is defined, the "Wetness" value will be displayed. Does not contribute to the value. | |||
|- style="vertical-align: top;" | |||
| <code>max_units</code> || || <code>UseDelta</code> || Displayed as "Wetness" if <code>wet_cooldown</code> is defined. Determines how much wetness is dried per unit. Displayed as a percentage. | |||
|- style="vertical-align: top;" | |||
| <code>poison_power</code> || || <code>PoisonPower</code> || The value of poison power attached to this item. | |||
|- style="vertical-align: top;" | |||
| colspan=4 style="background-color: var(--color-red); color: white; text-align: center;" | | |||
===Cooking=== | |||
|- | |||
! colspan="3" | Parameter !! rowspan="2" | Description | |||
|- | |||
! Preferred !! Alternative !! Game files | |||
|- style="vertical-align: top;" | |||
| <code>cook_minutes</code> || || <code>MinutesToCook</code> || How long it takes before this item is "cooked". The unit "minutes" is appended after the value. | |||
|- style="vertical-align: top;" | |||
| <code>burn_minutes</code> || || <code>MinutesToBurn</code> || How long it takes before this item is "burnt". The unit "minutes" is appended after the value. | |||
|- style="vertical-align: top;" | |||
| <code>dangerous_uncooked</code> || || <code>DangerousUncooked</code> || Set to <code>TRUE</code> if the item can make the player sick if consumed before cooking it. | |||
|- style="vertical-align: top;" | |||
| <code>bad_microwaved</code> || || <code>BadInMicrowave</code> || Set to <code>TRUE</code> if this item is of a poorer quality when cooked in a microwave. | |||
|- style="vertical-align: top;" | |||
| <code>good_hot</code> || || <code>GoodHot</code> || Set to <code>TRUE</code> if this item is of a superior quality when consumed hot. | |||
|- style="vertical-align: top;" | |||
| <code>bad_cold</code> || || <code>BadCold</code> || Set to <code>TRUE</code> if this item is of a poorer quality when consumed cold. | |||
|- style="vertical-align: top;" | |||
| <code>spice</code> || || <code>Spice</code> || Set to <code>TRUE</code> if this item is considered a "spice" in cooking recipes. | |||
|- style="vertical-align: top;" | |||
| <code>evolved_recipe</code> || || <code>EvolvedRecipeName</code> || The name of the item used in evolved recipes. Not a list of recipes this can be used in. | |||
|- style="vertical-align: top;" | |||
| colspan=4 style="background-color: var(--color-red); color: white; text-align: center;" | | |||
===Crafting=== | |||
|- | |||
! colspan="3" | Parameter !! rowspan="2" | Description | |||
|- | |||
! Preferred !! Alternative !! Game files | |||
|- style="vertical-align: top;" | |||
| <code>workstation</code> || || || The workstation/tile needed to craft the item. | |||
|- style="vertical-align: top;" | |||
| <code>tool</code> || || || The tool needed to craft the item. Up to 6 different tools can be defined, by adding a suffix id to the end of the parameter, e.g., <code>tool2</code>. | |||
|- style="vertical-align: top;" | |||
| <code>tool_tag</code> || || || The tag of the tool needed to craft the item. Up to 6 different tools can be defined, by adding a suffix id to the end of the parameter, e.g., <code>tool_tag2</code>. '''''Will not work if {{code|tool}} with the same suffix id is defined. ''''' | |||
|- style="vertical-align: top;" | |||
| <code>ingredients</code> || || || List of ingredients required to craft the tile. Each entry should be a link to the item and separated by {{code|<br>}}, e.g., {{code|2×[[Planks]]<br>4×[[Nails]]}}. | |||
|- style="vertical-align: top;" | |||
| colspan=4 style="background-color: var(--color-red); color: white; text-align: center;" | | |||
===Technical=== | |||
|- | |||
! colspan="3" | Parameter !! rowspan="2" | Description | |||
|- | |||
! Preferred !! Alternative !! Game files | |||
|- style="vertical-align: top;" | |||
| <s><code>tags</code></s> || || <code>Tags</code> || <s>The <code>Tags</code> attributes for the item, that are used to define/group its functionality. Each value should be separated by {{code|<br>}}</s> | |||
|- style="vertical-align: top;" | |||
| <code>tag</code> || || <code>Tags</code> || The <code>Tags</code> attributes for the item, which will [[Template:Tag link|automatically]] create a link to [[Item tags]]. Up to 6 different tags can be defined, by adding a suffix id to the end of the parameter, e.g., <code>tag2</code>. Will not work if {{code|tags}} is already defined. | |||
|- style="vertical-align: top;" | |||
| <code>item_id</code> || <code>class_name</code>{{sup|deprecated}} || <code>[module].[type]</code> || The ID of the item. The format is <code>[module].[type]</code>. This can be found in-game with debug, in the item list. Otherwise, in the item scripts where <code>[module]</code> is the name of the outermost block, e.g., <code>Base</code>, <code>radio</code>, <code>farming</code>, <code>camping</code>. <br>Multiple item IDs can be set by either: separating with {{code|<br>}} or adding a 'suffix id' to the end (up to 10), e.g., <code>item_id2</code>. | |||
|- style="vertical-align: top;" | |||
| <code>item_id_more</code> || || || If there are too many item IDs to be listed in the infobox, this can be used to define a link to a section on the page. E.g., <code>item_id_more=Item IDs</code>, will link to the "Item IDs" section on that page. | |||
|- style="vertical-align: top;" | |||
| <code>guid</code> || || || The "GUID" is a unique identifier used for some items to be used in various systems. For clothing this is found in <code>fileGuidTable.xml</code>. | |||
|- style="vertical-align: top;" | |||
| <code>guid_more</code> || || || If there are too many GUIDs to be listed in the infobox, this can be used to define a link to a section on the page. E.g., <code>guid_more=Item IDs</code>, will link to the "Item IDs" section on that page. | |||
|- style="vertical-align: top;" | |||
| <code>media_id</code> || || || The media ID for recorded media. Found in <code>recorded_media.lua</code>. <br>''E.g., <code>89108e07-fc70-4eec-a267-790d6f4b9831</code> for '''CD: Your smile. Your kiss.''''' | |||
|} | |||
{{Translation guide|<syntaxhighlight lang="html"> | |||
{{#switch: {{{1|}}} | |||
<!-- Section: General --> | |||
| general = General | |||
| category = Category | |||
| weight = Encumbrance | |||
| weight_equipped = when equipped | |||
| empty = empty | |||
| full = full | |||
| with_organized = with organized trait. | |||
| with_disorganized = with disorganized trait. | |||
| equipped = Equipped | |||
| slot_attached = Slot attached | |||
| back = Back | |||
| belt = Belt | |||
| holster = Holster | |||
| n-a = N/A | |||
| n-a_slot_desc = This item cannot be attached to any slot. | |||
| function = Function | |||
| secondary = Secondary | |||
| slots_added = Slots added | |||
| used_in = Used in | |||
| part_type = Part type | |||
| skill = Skill | |||
| n-a_skill_desc = This item has no skill associated with it. | |||
| ammunition = Ammunition | |||
| clip_size = Magazine size | |||
<!-- Section: Properties --> | |||
| properties = Properties | |||
| material = Material | |||
| quantity = quantity | |||
| contents = Contents | |||
| capacity = Capacity | |||
| ammo = Ammo | |||
| round = round | |||
| rounds = rounds | |||
| box = (box) | |||
| box_capacity_desc = Number of items when combined into a box. | |||
| units = units | |||
| can_boil_water = Can boil water | |||
| consumed = Consumed | |||
| writable = Writable | |||
| recipes = Skills learned | |||
| total_pages = Total pages | |||
| page = page | |||
| pages = pages | |||
| total_volumes = Total volumes | |||
| volume = volume | |||
| volumes = volumes | |||
| packaged = Packaged | |||
| packaged_desc = Nutritional information always known | |||
| rain_factor = Rain factor | |||
| days_fresh = Days fresh | |||
| days_rotten = Days until rotten | |||
| days = days | |||
| condition_max = Condition max. | |||
| base_durability = Base durability | |||
| base_durability_desc = Average number of hits before breaking at level 0. | |||
| run_speed = Run speed | |||
| combat_speed = Combat speed | |||
| scratch_defense = Scratch defence | |||
| bite_defense = Bite defence | |||
| bullet_defense = Bullet defence | |||
| neck_protection = Neck protection | |||
| insulation = Insulation | |||
| wind_resistance = Wind resistance | |||
| water_resistance = Water resistance | |||
| light_distance = Light distance | |||
| light_strength = Light strength | |||
| torch_cone = Torch cone | |||
| wet_cooldown = Wet cooldown | |||
| second = second | |||
| seconds = seconds | |||
| sensor_range = Sensor range | |||
| tile = tile | |||
| tiles = tiles | |||
| energy_source = Energy source | |||
| portable = Portable | |||
| two_way = Two-way | |||
| mic_range = Mic range | |||
| transmit_range = Transmit range | |||
| frequency_range = Frequency range | |||
<!-- Section: Performance --> | |||
| performance = Performance | |||
| damage_type = Damage type | |||
| damage = Damage | |||
| door_damage = Door damage | |||
| tree_damage = Tree damage | |||
| range = range | |||
| min_range = Min range | |||
| max_range = Max range | |||
| accuracy = Accuracy | |||
| recoil = Recoil | |||
| noise_radius = Noise radius | |||
| attack_speed = Attack speed | |||
| knockback = Knockback | |||
| knockdown = Knockdown | |||
| aiming_time = Aiming time | |||
| reload_time = Reload time | |||
| crit_chance = Crit chance | |||
| crit_chance_desc = Damage multiplied by {{{2}}} | |||
| spread = Spread | |||
| special_ability = Special ability | |||
| encumbrance_mod = Encumbrance mod. | |||
| effect_power = {{{2|Effect}}} power | |||
| effect_range = {{{2|Effect}}} range | |||
| effect_duration = {{{2|Effect}}} duration | |||
| minutes = minutes | |||
| effect_timer = {{{2|Effect}}} timer | |||
<!-- Section: Nutrition --> | |||
| nutrition = Nutrition | |||
| hunger = Hunger | |||
| thirst = Thirst | |||
| calories = Calories | |||
| carbohydrates = Carbohydrates | |||
| proteins = Proteins | |||
| fat = Fat | |||
<!-- Section: Effect --> | |||
| effect = Effect | |||
| unhappiness = Unhappiness | |||
| boredom = Boredom | |||
| stress = Stress | |||
| panic = Panic | |||
| enburance = Endurance | |||
| fatigue = Fatigue | |||
| cold = Cold | |||
| pain = Pain | |||
| sick = Sick | |||
| alcohol = Alcohol | |||
| sterilize_power = Sterilize power | |||
| disinfection = Disinfection | |||
| antibiotics_power = Antibiotic power | |||
| infections = Infections | |||
| bandage_power = Bandage power | |||
| wetness = Wetness | |||
| wetness_desc = Dries 4% of total wetness per unit | |||
| poison = Poison | |||
<!-- Section: Cooking --> | |||
| cooking = Cooking | |||
| time_until_cooked = Time until cooked | |||
| minutes = minutes | |||
| time_until_burned = Time until burned | |||
| dangerous_uncooked = Dangerous uncooked | |||
| bad_microwaved = Bad microwaved | |||
| goot_hot = Good hot | |||
| bad_cold = Bad cold | |||
| spice = Spice | |||
| custom_recipe = Custom recipe | |||
<!-- Section: Crafting --> | |||
| crafting = Crafting | |||
| workstation = Workstation | |||
| tools = Tool(s) | |||
| ingredients = Ingredients | |||
<!-- Section: Technical --> | |||
| technical = Technical | |||
| tags = Tags | |||
| item_id = Item ID | |||
| guid = GUID | |||
| media_id = Media ID | |||
| #default = {{Error|translation}} | |||
}} | }} | ||
</ | </syntaxhighlight>}} | ||
==See also== | |||
*{{ll|Template:Infobox tile}} | |||
*{{ll|Template:Infobox vehicle}} |
Latest revision as of 01:38, 2 May 2024
This is a documentation subpage for Template:Infobox item.
It contains usage information and other content that is not part of the original template page. |
All item infoboxes use this template.
Basic usage
{{Infobox item |name= |model= |icon= |icon_name= |category= |weight= |item_id= }}
Detailed usage
Weapon
{{Infobox item
|name=
|model=
|icon= <!-- icon2, icon3, ... -->
|icon_name= <!-- icon_name2, icon_name3, ... -->
<!--General-->
|category=
|weight=
|equipped=
|attachment_type=
|function=
|skill_type=
|ammo_type=
|clip_size=
<!--Properties-->
|material= <!-- E.g., Metal -->
|material_value= <!-- E.g., MetalValue attribute -->
|condition_max=
|condition_lower_chance=
|attack_speed=
<!--Performance-->
|damage_type=
|min_damage=
|max_damage=
|door_damage=
|tree_damage=
|min_range=
|max_range=
|sound_radius=
|base_speed=
|push_back=
|aiming_time=
|reload_time=
|crit_chance=
|crit_multiplier=
|kill_move=
<!--Technical-->
|tag=
|item_id=
}}
Weapon part
{{Infobox item
|name=
|model=
|icon= <!-- icon2, icon3, ... -->
|icon_name= <!-- icon_name2, icon_name3, ... -->
<!--General-->
|category=
|weight=
|part_type=
|function=
|weapon=
|ammo_type=
|clip_size=
<!--Properties-->
|material= <!-- E.g., Metal -->
|material_value= <!-- E.g., MetalValue attribute -->
<!--Performance-->
|damage_mod=
|min_range_mod=
|max_range_mod=
|recoil_delay=
|sound_radius=
|aiming_time=
|reload_time=
|angle_mod=
|weight_mod=
<!--Crafting-->
|workspace=
|tool=
|ingredients=
<!--Technical-->
|tag=
|item_id=
}}
Ammo
{{Infobox item
|name=
|model=
|model2=
|icon=
|icon_name=
|icon2=
|icon_name2=
<!--General-->
|category=Ammo
|weight=
|weight_text=(single)
|weight2=
|weight_text2=(box)
|weapon=
<!--Properties-->
|material=
|material_value=
|capacity=
<!--Crafting-->
|workspace=
|tool=
|ingredients=
<!--Technical-->
|tag=
|item_id=
}}
Clothing
{{Infobox item
|name=
|model=
|icon= <!-- icon2, icon3, ... -->
|icon_name= <!-- icon_name2, icon_name3, ... -->
<!--General-->
|category=
|weight=
|capacity=
|weight_reduction=
|body_location=
|function=
|attachments_provided
<!--Properties-->
|material= <!-- E.g., FabricType attribute -->
|condition_max=
|condition_lower_chance=
|run_speed=
|combat_speed=
|scratch_defense=
|bite_defense=
|bullet_defense=
|neck_protection=
|insulation=
|wind_resistance=
|water_resistance=
<!--Technical-->
|tag=
|item_id=
}}
Bag
{{Infobox item
|name=
|model=
|icon= <!-- icon2, icon3, ... -->
|icon_name= <!-- icon_name2, icon_name3, ... -->
<!--General-->
|category=
|weight=
|capacity=
|weight_reduction=
|equipped= <!-- E.g., CanBeEquipped attribute -->
|function=
<!--Properties-->
|material= <!-- E.g., FabricType attribute -->
|weight_reduction=
|run_speed=
|combat_speed=
<!--Technical-->
|tag=
|item_id=
}}
Medical
{{Infobox item
|name=
|model=
|icon= <!-- icon2, icon3, ... -->
|icon_name= <!-- icon_name2, icon_name3, ... -->
<!--General-->
|category=
|weight=
|function=
|max_units=
<!--Nutrition-->
|hunger_change=
|calories=
<!--Properties-->
|material= <!-- or |metal_value= -->
|material_value= <!-- or |metal_value= -->
|max_units= <!-- Do not add again if already defined in General section -->
<!--Effect-->
|unhappy_change=
|boredom_change=
|stress_change=
|fatigue_change=
|endurance_change=
|flu_change=
|pain_change=
|sick_change=
|reduce_infection_power=
|alcohol_power=
|wet_cooldown=
|bandage_power=
<!--Crafting-->
|workspace=
|tool=
|ingredients=
<!--Technical-->
|tag=
|item_id=
}}
Water container
{{Infobox item
|name=
|model=
|icon=
|icon_name=
<!--General-->
|category=
|weight=
|weight_full=
|function=
<!--Properties-->
|max_units=
|contents=
|can_boil_water=
|rain_factor=
|material= <!-- or |metal_value= -->
|material_value= <!-- or |metal_value= -->
<!--Technical-->
|tag=
|item_id=
}}
Communication
{{Infobox item
|name=
|model=
|icon= <!-- icon2, icon3, ... -->
|icon_name= <!-- icon_name2, icon_name3, ... -->
<!--General-->
|category=
|weight=
|function=
<!--Properties-->
|material=
|material_value=
|weight_reduction=
|condition_max=
|condition_lower_chance=
|energy_source=
|portable=
|two_way=
|mic_range=
|transmit_range=
|min_channel=
|max_channel=
<!--Performance-->
|sound_radius=
<!--Crafting-->
|workspace=
|tool=
|ingredients=
<!--Technical-->
|tags=
|item_id=
}}
Food
{{Infobox item
|name=
|model=
|icon= <!-- icon2, icon3, ... -->
|icon_name= <!-- icon_name2, icon_name3, ... -->
<!--General-->
|category=
|weight=
|function=
|max_units=
|days_fresh=
|days_rotten=
|cant_be_frozen=
|packaged=
<!--Nutrition-->
|hunger_change=
|thirst_change=
|calories=
|lipids=
|proteins=
|carbohydrates=
<!--Effect-->
|unhappy_change=
|boredom_change=
|stress_change=
|fatigue_change=
|endurance_change=
|flu_change=
|pain_change=
|sick_change=
|reduce_infection_power=
|alcohol_power=
|poison_power=
<!--Cooking-->
|cook_minutes=
|burn_minutes=
|dangerous_uncooked=
|bad_microwaved=
|good_hot=
|bad_cold=
|spice=
|evolved_recipe=
<!--Crafting-->
|workspace=
|tool=
|ingredients=
<!--Technical-->
|tag=
|item_id=
}}
Literature
{{Infobox item
|name=
|model=
|icon= <!-- icon2, icon3, ... -->
|icon_name= <!-- icon_name2, icon_name3, ... -->
<!--General-->
|category=
|weight=
|function=
<!--Properties-->
|consumed=
|writable=
|recipes=
|page_number=
|vol_number=
<!--Effect-->
|unhappy_change=
|boredom_change=
|stress_change=
<!--Technical-->
|tag=
|item_id=
}}
Light source
{{Infobox item
|name=
|model=
|icon=
|icon_name=
<!--General-->
|category=
|weight=
|function=
<!--Properties-->
|material= <!-- or |metal_value= -->
|material_value= <!-- or |metal_value= -->
|max_units=
|light_distance=
|light_strength=
|torch_cone=
|energy_source=
<!--Technical-->
|tag=
|item_id=
}}
Media
{{Infobox item
|name=
|model=
|icon=
|icon_name=
<!--General-->
|category=
|weight=
<!--Properties-->
|skill_trained=
<!--EFFECT-->
|unhappy_change=
|boredom_change=
|stress_change=
|panic_change=
|fatigue_change=
|endurance_change=
|fitness_change=<!--currently unused-->
|drunk_change=<!--currently unused-->
|anger_change=<!--currently unused-->
|morale_change=<!--currently unused-->
|fear_change=<!--currently unused-->
<!--Technical-->
|item_id=
|media_id=
}}
Other
{{Infobox item
|name=
|model=
|icon=
|icon_name=
<!--General-->
|category=
|weight=
|function=
<!--Properties-->
|material= <!-- or |metal_value= -->
|material_value= <!-- or |metal_value= -->
|max_units=
<!--Crafting-->
|workspace=
|tool=
|ingredients=
<!--Technical-->
|tag=
|item_id=
}}
Parameters
Any of the following parameters can be used in the template, regardless of whether or not they're included in the above examples.
Name and images | |||
Parameter | Description | ||
---|---|---|---|
Preferred | Alternative | Game files | |
name |
display_name |
DisplayName |
The name of the item. Displayed at the top of the infobox. Can be different if overwritten by the ItemName_EN.txt file.Default: uses page name |
model |
image |
WorldStaticModel WeaponSprite |
The model of the item. Default: uses the icon upscaled with pixelated class |
model_width |
image_width |
Default: 200px (128px if model is blank) | |
model_caption |
image_caption |
The caption of the model/image. Displayed beneath the image/model. | |
icon |
Icon IconsForTexture |
The icon of the item. For multiple icons, add any number from 2-16 to the parameter. E.g., icon2 .
| |
icon_width |
icon parameter. E.g., icon_width2 . | ||
icon_name |
The tooltip to be displayed when hovering over the icon. For multiple icons, use the same number as the icon parameter. E.g., icon_name2 .
| ||
icon_link |
icon parameter. E.g., icon_link2 . | ||
General | |||
Parameter | Description | ||
Preferred | Alternative | Game files | |
category |
DisplayCategory Type |
The in-game category for the item. | |
weight |
Weight |
The encumbrance (previously weight) of the item. Up to 3 weights can be defined, by appending a suffix id. E.g., weight2 . Encumbrance when equipped will be calculated automatically and added as a tooltip.
| |
weight_text |
Text to append to the end of the weight value with the same suffix id. E.g., weight_text2 .
| ||
weight_full |
The weight of the item when full. Leaving blank will calculate the weight of a bag when full, so long as capacity and weight_reduction are added. Weight organized and disorganized traits will be calculated automatically and added as a tooltip.
| ||
capacity |
Capacity |
The capacity of the item, to be used in the weight_full value, or displayed in the properties section. \May be for bags or "drainable" items. | |
weight_reduction |
WeightReduction |
The encumbrance reduction of the item. Used in calculating the weight when value. | |
body_location |
equipped |
BodyLocation RequiresEquippedBothHands TwoHandWeapon |
body_location to be used for clothing.equipped to be used for other items, like weapons.
|
attachment_type |
AttachmentType |
The slot the item is attached to. Typically used for weapons. | |
function |
primary_use Deprecatedsecondary_use Deprecated |
||
secondary_item |
OtherHandRequire |
Item to be equipped in the secondary hand for the item to function. | |
attachments_provided |
AttachmentsProvided |
The attachment slots provided by the item. Typical of belts. | |
weapon |
weapons Deprecated |
MountOn |
Weapons that the item is used in. Multiple weapons can be set by using weapon2 , weapon3 , etc., up to weapon5 .Add a weapon using a wikilink ( [[weapon]] ) or an image ([[File:weapon_icon.png|link=weapon]] ).
|
part_type |
PartType |
Part of the weapon that it is attached to. | |
skill_type |
Categories |
The skill the item is associated with. Typically used with weapons. | |
ammo_type |
ammo |
AmmoType |
The type of ammo used in the item/firearm. |
clip_size |
MaxAmmo |
The maximum ammo the item can contain. Typically used for firearms and magazines. | |
Properties | |||
Parameter | Description | ||
Preferred | Alternative | Game files | |
material |
FabricType MetalValue |
The material the item is made of. Usage is not strict. Intended use is for items with MetalValue , or FabricType (Cotton, Leather, or Denim).
| |
material_value |
MetalValue |
How much of the material the item contains. The material parameter will be included in the group title.
| |
contents |
Alternate to material , especially if the material is fuzzy, e.g., A water bottle can hold water or gas.
| ||
capacity Containermax_units Drainable |
UseDelta DrainableCount Ammo |
1) | |
weight_reduction |
WeightReduction |
Encumbrance reduction of the item. Used to calculate the "Full encumbrance" value. Displayed as a percentage. | |
weight_reduction_text |
weight_reduction . Typical usage: (full) | ||
can_boil_water |
IsCookable CanBoilWater |
Set to TRUE if the item can be used to boil water.
| |
consumed |
Set to TRUE if the item is consumed once used/depleted. Intended to be used for literature items only. Not to be used for food.
| ||
writable |
CanBeWrite |
Set to TRUE if the item can be written in.
| |
recipes |
skill_trained |
TeachedRecipes SkillTrained |
The recipes or skills that are learned from the item (magazine or book). |
page_number |
NumberOfPages PageToWrite |
Number of pages in the item. | |
vol_number |
Number of volumes for the series. | ||
packaged |
Packaged |
Set to TRUE if the item is packaged. Unlocks ability to look at the nutritional content.
| |
rain_factor |
RainFactor |
Determines how quickly an item can fill up with water if left out in the rain. | |
days_fresh |
DaysFresh |
The amount of days this item is recognized as "fresh". The unit "days" is appended after the value. Chilled and frozen calculated automatically and added as a tooltip. | |
days_rotten |
DaysTotallyRotten |
The amount of days before this item is recognized as "rotten". The unit "days" is appended after the value. Chilled and frozen calculated automatically and added as a tooltip. | |
cant_be_frozen |
CantBeFrozen |
Set to true if the item can be frozen, delaying time before the food rots. Used in calculations for days_fresh and days_rotten tooltip.
| |
condition_max |
ConditionMax |
The item's maximum condition, i.e. when it's fully repaired. Used in the calculation for "Base durability" if condition_lower_chance is defined.
| |
condition_lower_chance |
ConditionLowerChanceOneIn |
The item's chance of lowering in durability. Used in the calculation for "Base durability". | |
base_durability |
ConditionMax ×ConditionLowerChanceOneIn |
||
run_speed |
RunSpeedModifier |
Run speed modifier. Note this is currently bugged/unimplemented, and has no in-game function. | |
combat_speed |
CombatSpeedModifier |
Combat speed modifier for clothing. | |
attack_speed |
|||
scratch_defense |
ScratchDefense |
Scratch defense modifier. Automatically converted to a percentage. | |
bite_defense |
BiteDefense |
Bit defense modifier. Automatically converted to a percentage. | |
bullet_defense |
BulletDefense |
Bullet defense modifier. Automatically converted to a percentage. | |
neck_protection |
NeckProtectionModifier |
Neck protection modifier. Automatically converted to a percentage. | |
insulation |
Insulation |
Insulation modifier. Automatically converted to a percentage. | |
wind_resistance |
WindResistance |
Wind resistance modifier. Automatically converted to a percentage. | |
water_resistance |
WaterResistance |
Water resistance modifier. Automatically converted to a percentage. | |
light_distance |
LightDistance |
The distance the light from the source will travel. | |
light_strength |
LightStrength |
The intensity/brightness of light the source provides. | |
torch_cone |
TorchCone |
Set to TRUE if the light from this item travels in a single direction, a.k.a torch cone.
| |
wet_cooldown |
WetCooldown |
Time it takes to dry 1 wet_cooldown unit. Calculated based on the input and displayed in seconds. | |
sensor_range |
remote_range |
SensorRange RemoteRange |
How close an entity needs to be before the trap is triggered, or the distance the remote needs to be in order to trigger. |
energy_source |
The energy source of the item. E.g., UsesBattery = TRUE would mean the energy source is a battery.
| ||
portable |
IsPortable |
Whether the item can be used while in the inventory, or if it must be placed on the ground in order to operate. | |
two_way |
TwoWay |
Whether the item can receive and transmit a signal. | |
mic_range |
MicRange |
Number of tiles the player must be within in order for the mic to transmit their voice. | |
transmit_range |
TransmitRange |
The distance in tiles the item will transmit | |
min_channel |
MinChannel |
The minimum bandwidth/frequency for selecting a channel. | |
max_channel |
MaxChannel |
The maximum bandwidth/frequency for selecting a channel. | |
Performance | |||
Parameter | Description | ||
Preferred | Alternative | Game files | |
damage_type |
DamageCategory |
The type of damage this weapon does. The attribute used to define this has an order of priority if it exists for the item.
| |
min_damage |
MinDamage |
Minimal weapon damage, before modifiers. | |
max_damage |
MaxDamage |
Maximum weapon damage, before modifiers. | |
door_damage |
DoorDamage |
Damage modifier done to doors. | |
tree_damage |
TreeDamage |
Damage modifier done to trees. | |
damage_mod |
DamageModifier |
||
min_range |
MinRange |
Range below which a weapon attack gets converted to shoving. | |
max_range |
MaxRange |
Range at which weapon gets 100% of its damage. | |
min_range_mod |
|||
max_range_mod |
hit_chance hit_chance_mod accuracy_mod |
||
recoil_delay |
recoil_mod recoil_delay_mod |
||
sound_radius |
SoundRadius |
||
base_speed |
BaseSpeed SwingTime |
Base speed of the weapon (previously the SwingTime attribute).
| |
push_back |
PushBackMod |
||
knockdown |
KnockdownMod |
||
aiming_time |
aiming_time_mod aiming_mod |
||
reload_time |
reload_time_mod reload_mod |
||
crit_chance |
CriticalChance |
Base critical chance value, before modifiers. | |
crit_multiplier |
CritDmgMultiplier |
Critical damage multiplier. | |
angle_mod |
spread_mod |
||
kill_move |
CloseKillMove |
||
weight_mod |
|||
effect_type |
|||
effect_power |
|||
effect_range |
|||
effect_duration |
|||
effect_timer |
|||
Nutrition | |||
Parameter | Description | ||
Preferred | Alternative | Game files | |
hunger_change |
HungerChange HUN |
The value of hunger that is changed from using/consuming this item. | |
thirst_change |
ThirstChange THI |
The value of thirst that is changed from using/consuming this item. | |
calories |
Calories |
The value of calories. | |
carbohydrates |
Carbohydrates |
The value of carbohydrates. | |
proteins |
Proteins |
The value of proteins. | |
lipids |
fat |
Lipids |
The value of lipids. |
Effect | |||
Parameter | Description | ||
Preferred | Alternative | Game files | |
unhappy_change |
UnhappyChange UHP |
The value of unhappiness that is changed from using/consuming this item. | |
boredom_change |
BoredomChange BOR |
The value of boredom that is changed from using/consuming this item. | |
stress_change |
StressChange STS |
The value of stress that is changed from using/consuming this item. | |
panic_change |
PAN |
The value of panic that is changed from using/consuming this item. | |
fatigue_change |
FatigueChange FAT |
The value of fatigue that is changed from using/consuming this item. | |
endurance_change |
EnduranceChange END |
The value of endurance that is changed from using/consuming this item. | |
flu_change |
FluReduction |
The value of flu/cold that is changed from using/consuming this item. | |
pain_change |
PainReduction PAI |
The value of pain that is changed from using/consuming this item. | |
sick_change |
ReduceFoodSickness SIC |
The value of sickness that is changed from using/consuming this item. | |
alcoholic |
alcohol |
Alcoholic DRU |
Whether this item is considered to be alcohol and therefore contributing to the drunk moodle. |
alcohol_power |
AlcoholPower |
The alcohol power of this item when used on wounds. | |
reduce_infection_power |
ReduceInfectionPower |
How much the item reduces wound infection. | |
bandage_power |
BandagePower |
How effective the item is at absorbing blood, and how frequently it needs to be replaced. | |
wet_cooldown |
WetCooldown |
If this value is defined, the "Wetness" value will be displayed. Does not contribute to the value. | |
max_units |
UseDelta |
Displayed as "Wetness" if wet_cooldown is defined. Determines how much wetness is dried per unit. Displayed as a percentage.
| |
poison_power |
PoisonPower |
The value of poison power attached to this item. | |
Cooking | |||
Parameter | Description | ||
Preferred | Alternative | Game files | |
cook_minutes |
MinutesToCook |
How long it takes before this item is "cooked". The unit "minutes" is appended after the value. | |
burn_minutes |
MinutesToBurn |
How long it takes before this item is "burnt". The unit "minutes" is appended after the value. | |
dangerous_uncooked |
DangerousUncooked |
Set to TRUE if the item can make the player sick if consumed before cooking it.
| |
bad_microwaved |
BadInMicrowave |
Set to TRUE if this item is of a poorer quality when cooked in a microwave.
| |
good_hot |
GoodHot |
Set to TRUE if this item is of a superior quality when consumed hot.
| |
bad_cold |
BadCold |
Set to TRUE if this item is of a poorer quality when consumed cold.
| |
spice |
Spice |
Set to TRUE if this item is considered a "spice" in cooking recipes.
| |
evolved_recipe |
EvolvedRecipeName |
The name of the item used in evolved recipes. Not a list of recipes this can be used in. | |
Crafting | |||
Parameter | Description | ||
Preferred | Alternative | Game files | |
workstation |
The workstation/tile needed to craft the item. | ||
tool |
The tool needed to craft the item. Up to 6 different tools can be defined, by adding a suffix id to the end of the parameter, e.g., tool2 .
| ||
tool_tag |
The tag of the tool needed to craft the item. Up to 6 different tools can be defined, by adding a suffix id to the end of the parameter, e.g., tool_tag2 . Will not work if tool with the same suffix id is defined.
| ||
ingredients |
List of ingredients required to craft the tile. Each entry should be a link to the item and separated by <br> , e.g., 2×[[Planks]]<br>4×[[Nails]] .
| ||
Technical | |||
Parameter | Description | ||
Preferred | Alternative | Game files | |
tags |
Tags |
Tags attributes for the item, that are used to define/group its functionality. Each value should be separated by <br> | |
tag |
Tags |
The Tags attributes for the item, which will automatically create a link to Item tags. Up to 6 different tags can be defined, by adding a suffix id to the end of the parameter, e.g., tag2 . Will not work if tags is already defined.
| |
item_id |
class_name Deprecated |
[module].[type] |
The ID of the item. The format is [module].[type] . This can be found in-game with debug, in the item list. Otherwise, in the item scripts where [module] is the name of the outermost block, e.g., Base , radio , farming , camping . Multiple item IDs can be set by either: separating with <br> or adding a 'suffix id' to the end (up to 10), e.g., item_id2 .
|
item_id_more |
If there are too many item IDs to be listed in the infobox, this can be used to define a link to a section on the page. E.g., item_id_more=Item IDs , will link to the "Item IDs" section on that page.
| ||
guid |
The "GUID" is a unique identifier used for some items to be used in various systems. For clothing this is found in fileGuidTable.xml .
| ||
guid_more |
If there are too many GUIDs to be listed in the infobox, this can be used to define a link to a section on the page. E.g., guid_more=Item IDs , will link to the "Item IDs" section on that page.
| ||
media_id |
The media ID for recorded media. Found in recorded_media.lua . E.g., 89108e07-fc70-4eec-a267-790d6f4b9831 for CD: Your smile. Your kiss.
|
How to translate
This template is translatable.
Template code
Paste the following code into the <includeonly>
tag of the translated template and translate the text after each =
sign (except for #default =
).
{{#switch: {{{1|}}}
<!-- Section: General -->
| general = General
| category = Category
| weight = Encumbrance
| weight_equipped = when equipped
| empty = empty
| full = full
| with_organized = with organized trait.
| with_disorganized = with disorganized trait.
| equipped = Equipped
| slot_attached = Slot attached
| back = Back
| belt = Belt
| holster = Holster
| n-a = N/A
| n-a_slot_desc = This item cannot be attached to any slot.
| function = Function
| secondary = Secondary
| slots_added = Slots added
| used_in = Used in
| part_type = Part type
| skill = Skill
| n-a_skill_desc = This item has no skill associated with it.
| ammunition = Ammunition
| clip_size = Magazine size
<!-- Section: Properties -->
| properties = Properties
| material = Material
| quantity = quantity
| contents = Contents
| capacity = Capacity
| ammo = Ammo
| round = round
| rounds = rounds
| box = (box)
| box_capacity_desc = Number of items when combined into a box.
| units = units
| can_boil_water = Can boil water
| consumed = Consumed
| writable = Writable
| recipes = Skills learned
| total_pages = Total pages
| page = page
| pages = pages
| total_volumes = Total volumes
| volume = volume
| volumes = volumes
| packaged = Packaged
| packaged_desc = Nutritional information always known
| rain_factor = Rain factor
| days_fresh = Days fresh
| days_rotten = Days until rotten
| days = days
| condition_max = Condition max.
| base_durability = Base durability
| base_durability_desc = Average number of hits before breaking at level 0.
| run_speed = Run speed
| combat_speed = Combat speed
| scratch_defense = Scratch defence
| bite_defense = Bite defence
| bullet_defense = Bullet defence
| neck_protection = Neck protection
| insulation = Insulation
| wind_resistance = Wind resistance
| water_resistance = Water resistance
| light_distance = Light distance
| light_strength = Light strength
| torch_cone = Torch cone
| wet_cooldown = Wet cooldown
| second = second
| seconds = seconds
| sensor_range = Sensor range
| tile = tile
| tiles = tiles
| energy_source = Energy source
| portable = Portable
| two_way = Two-way
| mic_range = Mic range
| transmit_range = Transmit range
| frequency_range = Frequency range
<!-- Section: Performance -->
| performance = Performance
| damage_type = Damage type
| damage = Damage
| door_damage = Door damage
| tree_damage = Tree damage
| range = range
| min_range = Min range
| max_range = Max range
| accuracy = Accuracy
| recoil = Recoil
| noise_radius = Noise radius
| attack_speed = Attack speed
| knockback = Knockback
| knockdown = Knockdown
| aiming_time = Aiming time
| reload_time = Reload time
| crit_chance = Crit chance
| crit_chance_desc = Damage multiplied by {{{2}}}
| spread = Spread
| special_ability = Special ability
| encumbrance_mod = Encumbrance mod.
| effect_power = {{{2|Effect}}} power
| effect_range = {{{2|Effect}}} range
| effect_duration = {{{2|Effect}}} duration
| minutes = minutes
| effect_timer = {{{2|Effect}}} timer
<!-- Section: Nutrition -->
| nutrition = Nutrition
| hunger = Hunger
| thirst = Thirst
| calories = Calories
| carbohydrates = Carbohydrates
| proteins = Proteins
| fat = Fat
<!-- Section: Effect -->
| effect = Effect
| unhappiness = Unhappiness
| boredom = Boredom
| stress = Stress
| panic = Panic
| enburance = Endurance
| fatigue = Fatigue
| cold = Cold
| pain = Pain
| sick = Sick
| alcohol = Alcohol
| sterilize_power = Sterilize power
| disinfection = Disinfection
| antibiotics_power = Antibiotic power
| infections = Infections
| bandage_power = Bandage power
| wetness = Wetness
| wetness_desc = Dries 4% of total wetness per unit
| poison = Poison
<!-- Section: Cooking -->
| cooking = Cooking
| time_until_cooked = Time until cooked
| minutes = minutes
| time_until_burned = Time until burned
| dangerous_uncooked = Dangerous uncooked
| bad_microwaved = Bad microwaved
| goot_hot = Good hot
| bad_cold = Bad cold
| spice = Spice
| custom_recipe = Custom recipe
<!-- Section: Crafting -->
| crafting = Crafting
| workstation = Workstation
| tools = Tool(s)
| ingredients = Ingredients
<!-- Section: Technical -->
| technical = Technical
| tags = Tags
| item_id = Item ID
| guid = GUID
| media_id = Media ID
| #default = {{Error|translation}}
}}
Template documentation
Copy the code wrapped in the <noinclude>
tag in this template and translate the text after doc =
in the {{Documentation}}
template.
{{Translation guide}}
template should be removed from the translated documentation.