Template:Consumable/doc

Overview

This template is used to display detailed information about consumable items such as food, drinks, alcohol, and potions.
It supports both crafted and dropped items and includes optional triggers, buffs, and flavor text.

Usage

Paste the following example into any page to use the template:

{{Consumable
| name = 
| tooltip_image = 

| is_soulbound = 
| category = 
| execution_time = 
| cooldown = 
| movement_penalty = 
| range = 
| angle = 
| effect_target = 
| effect_duration = 
| effect_value = 

| stat1_name = 
| stat1_value = 
| stat2_name = 
| stat2_value = 
| stat3_name = 
| stat3_value = 
| stat4_name = 
| stat4_value = 
| stat5_name = 
| stat5_value = 
| stat6_name = 
| stat6_value = 

| trigger_type = 
| trigger_chance = 
| trigger_max_hits = 
| trigger_effect = 
| trigger_duration = 

| level_requirement = 
| class_requirement1 = 
| class_requirement2 = 
| class_requirement3 = 

| flavor_text = 

| crafting_profession = 
| recipe_page = 

| component1_name = 
| component1_material = 
| component1_material_category = 
| component2_name = 
| component2_material = 
| component2_material_category = 
| component3_name = 
| component3_material = 
| component3_material_category = 
| component4_name = 
| component4_material = 
| component4_material_category = 
| component5_name = 
| component5_material = 
| component5_material_category = 

| how_to_acquire = 
| sell_price = 
}}

Parameters

name: Optional. The name of the item (defaults to the page name).
tooltip_image: File name of the item's tooltip image (without the "File:" prefix).
is_soulbound: Set to any non-blank value to display the soulbound warning.

category: Type of consumable (e.g., Food, HealthPotion, UtilityConsumable, "UncategorizedPotion").
execution_time: Time required to use the item (e.g., 4s).
cooldown: Cooldown period after use (e.g., 1m).
movement_penalty: Movement speed penalty applied during use.
range: Maximum distance from the target, if applicable (e.g., 10m).
angle: Cone angle for the item’s targeting, if applicable.
effect_target: The target of the item’s effect (e.g., Self Target, Defensive Target).
effect_duration: How long the effect lasts once applied.
effect_value: Description of the primary effect (can be plain text or include formatting).

stat1_name – stat6_name: Optional stat boosts applied while the effect is active (e.g., Penetration, Resilience, 1H Weapon Damage, Ranged Damage).
stat1_value – stat6_value: Values for the corresponding stats (e.g., +5).

trigger_type: Trigger condition (e.g., On Get Hit, On Use).
trigger_chance: Chance for the effect to trigger (e.g., 10%).
trigger_max_hits: Optional. Max number of times the trigger can activate (e.g., 20).
trigger_effect: Description of the effect triggered (supports line breaks via <br />).
trigger_duration: How long the triggered effect lasts (e.g., 10s).

level_requirement: Minimum level required to use the item.
class_requirement1 – class_requirement3: Classes that can use the item. (Almost always Adventuring)

flavor_text: Optional flavor text. Will appear in blue italicized style beneath the main effect.

crafting_profession: The profession that crafts the item (e.g., Provisioner).
recipe_page: Name of the recipe page used to create the item. (e.g., Kings Potion Recipe::King's Potion)

component1_name – component5_name: Display names of each component (e.g., Base, Additive).
component1_material – component5_material: Exact materials used (e.g., Rough Ramie, Iron Dust).
component1_material_category – component5_material_category: Optional. Used to link material categories (e.g., Pine Wood, Cloth, Fletching).

You can enter multiple values separated by commas.

how_to_acquire: Comma-separated list of sources. Use pretty link format when the page link isn't clean (e.g., Doe/Newhaven_Valley::Doe (Newhaven Valley)).
sell_price: How much the item can be vendored for (e.g., 20 Silver).