Template:Consumable

Documentation

[purge]

This template aims to provide a comprehensible and complete way of adding an infobox to Consumable items and Plants and Seeds. Based on JPMKn user wikitable

Usage

• Use this template to add an Portable Infobox to most items.
• If you don't have info or don't feel the need to add it just leave the parameter empty, don't cut it out.
• If anything needs to be added, feel free to do so (:

---

Template ready to use

{{Consumable
|title      = 
|image      = 
|caption    = 
|alias      = 
|obtained   = 
|type       = 
|id         = 
|stack      = 
|added      = 
|health     = 
|stamina    = 
|energy     = 
|hydration  = 
|fullness   = 
|poison     = 
|spoil      = 
|cook       = 
|effects    = 
|items      = 
|ing        = 
|consumable = 
|equippable = 
|storage    = 
|used       = 
}}

---

Template with Explanation

{{Consumable
|title      = Title, by default it's page name
|image      = Filename representing the item
|caption    = Image description if needed
|alias      = Other names for the item
|obtained   = Check the lower page part for more info
|type       = Check the lower page part for more info
|id         = Item ID number
|stack      = Max. inventory stack size
|added      = Version of the game when the item was added
|health     = Health impact of the item
|stamina    = Stamina impact of the item
|energy     = Energy impact of the item
|hydration  = Hydration impact of the item
|fullness   = Fullness impact of the item
|poison     = Poisoning effect of the item
|spoil      = Specifies if the item spoils (Yes/No)
|cook       = Specifies if the item is cookable (Yes/No)
|effects    = Special effects after cooking
|items      = Ingredients for cooking
|ing        = Crafting ingredients for the item
|consumable = Specifies if the item is consumable (Yes/No)
|equippable = Specifies if the item is equippable (Yes/No)
|storage    = Where the item can be stored
|used       = Who or what uses/needs the item
}}

---

Example

Ramen Noodles
Meta Info
Other names:	Instant Noodles
Obtained:	Collecting
Item type:	Consumable
Item ID:	421
Stack size:	6
Added in:	Early Game Access
Consumable Info
Affects Energy:	30%
Affects Hydration:	-25%
Affects Fullness:	25%
Spoils:	No
Cookable:	Yes
Other Info
Consumable:	Yes
Equippable:	No
Storage:	• Inventory • Shelf • Wall Shelf
Used by:	• Chicken Noodle Soup • Kitchen Sink

{{Consumable
|title      = Ramen Noodles
|image      = Ramen Noodles Icon.png
|caption    =
|alias      = Instant Noodles
|obtained   = Collecting
|type       = [[Items#Consumables|Consumable]]
|id         = 421
|stack      = 6
|added      = [[Updates|Early Game Access]]
|health     = 
|stamina    = 
|energy     = <span style="color:#00FF00">30%</span>
|hydration  = <span style="color:#FF0000">-25%</span>
|fullness   = <span style="color:#00FF00">25%</span>
|poison     = 
|spoil      = No
|cook       = Yes
|effects    = 
|items      = 
|ing        = 
|consumable = Yes
|equippable = No
|storage    = • [[Inventory]] <br> • [[Prefab Buildings#Shelf|Shelf]] <br> • [[Prefab Buildings#Wall Shelf|Wall Shelf]]
|used       = • [[Cooking#Chicken Noodle Soup|Chicken Noodle Soup]] <br> • [[Cooking#Kitchen Sink|Kitchen Sink]]
}}

Tips & Tricks

Use this green colour for positive values

<span style="color:#00FF00">%</span>

and this red colour for negative ones

<span style="color:#FF0000">-%</span>

---

Currently usable Parameters

Please only use these parameters to keep all Infoboxes consistent.

|obtained

• Collecting - just picking up
• Cooking    - mixing food in Cooking Pot
• Crafting   - self explanatory
• Farming    - growing plants
• Hunting    - killing animals
• Looting    - opening stuff / killing enemies
• Cheating   - using console commands

|type

• [[Items#Consumables|Consumable]]
• [[Items#Plants and Seed|Plant / Seed]]

---

Template data

Template for: Consumables.

Template parameters

Parameter		Description	Type	Status
Title	|title	Title of the item. Default Page name	String	required
Image	|image	Filename representing the item.	String	required
Caption	|caption	Image description if needed.	String	optional
Alias	|alias	Other names for the item.	String	optional
Obtained	|obtained	How the item is obtained. Check this for [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].	String	required
Type	|type	Type of the item. Check this for [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].	String	required
Item ID	|id	Item ID number.	Number	required
Stack size	|stack	Maximum inventory stack size.	Number	required
Game Version	|added	Version of the game when the item was added.	String	required
Health	|health	Health impact of the item.	String	optional
Stamina	|stamina	Stamina impact of the item.	String	optional
Energy	|energy	Energy impact of the item.	String	optional
Hydration	|hydration	Hydration impact of the item.	String	optional
Fullness	|fullness	Fullness impact of the item.	String	optional
Poisonous	|poison	Poisoning effect of the item.	String	optional
Spoilable	|spoil	Specifies if the item spoils (Yes/No).	String	required
Cookable	|cook	Specifies if the item is cookable (Yes/No).	String	required
Effects	|effects	Special effects after cooking.	String	optional
Ingredients	|items	Ingredients for cooking.	String	optional
Crafting	|ing	Crafting ingredients for the item.	String	optional
Consumable	|consumable	Specifies if the item is consumable (Yes/No).	String	required
Equippable	|equippable	Specifies if the item is equippable (Yes/No).	String	required
Storage	|storage	Where the item can be stored.	String	required
Used	|used	Who or what uses/needs the item.	String	optional

The above documentation is transcluded from Template:Consumable/doc. (edit | history)