Template:Infobox food/doc

From PZwiki
Notebook.png
This is a documentation subpage for Template:Infobox food.
It contains usage information and other content that is not part of the original template page.

This template is used to create an infobox in an article about food items.

Usage

To use this template in an article, copy the template below, then paste the template into an article.

All parameters are optional – those you do not populate with data will not show up in the infobox when the article is saved.

It is strongly advised to only include variables that are relevant to the specific item in question, i.e. parameters that do not display as false or 0 (excluding nutrition values).

display_name
{{{display_name}}}
alternate_name alternate_name2 alternate_name3 alternate_name4 alternate_name5 alternate_name6 alternate_name7 alternate_name7
alternate_name9 alternate_name10 alternate_name11 alternate_name12 alternate_name13 alternate_name14 alternate_name15 alternate_name16
General
Category category
Encumbrance
Heavy Load
weight
Function function
Capacity max_units units
Days until stale days_fresh days
Days until rotten days_rotten days
Can't be frozen cant_be_frozen
Packaged packaged
Nutrition
Hunger
Hunger
hunger_change
Thirst
Thirst
thirst_change
Calories
Calories
calories
Carbohydrates
Carbohydrates
carbohydrates
Proteins
Proteins
proteins
Fat
Fat
lipids
Effect
Unhappiness
Unhappiness
unhappy_change
Boredom
Boredom
boredom_change
Stress
Stress
stress_change
Fatigue
Tired
fatigue_change
Endurance
Endurnace
endurance_change
Cold
Cold
flu_change
Pain
Pain
pain_change
Sick
Sick
sick_change
Reduce infection reduce_infection_power%
Alcohol
Drunk
alcohol_power
Poison
SkullPoison.png
poison_power
Cooking
Time until cooked cook_minutes minutes
Time until burned burn_minutes minutes
Dangerous uncooked dangerous_uncooked
Bad microwaved bad_microwaved
Good hot good_hot
Bad cold bad_cold
Spice spice
Technical details
Item ID Item IDs


{{Infobox food
|name =
|name_colour=
|name_text_colour=
|image=
|image_width=
|alternate_image=
|alternate_name=
|alternate_link=
|alternate_image2=
|alternate_name2=
|alternate_link2=
|alternate_image3=
|alternate_name3=
|alternate_link3=
|alternate_image4=
|alternate_name4=
|alternate_link4=
|alternate_image5=
|alternate_name5=
|alternate_link5=
|alternate_image6=
|alternate_name6=
|alternate_link6=
|alternate_image7=
|alternate_name7=
|alternate_link7=
|alternate_image8=
|alternate_name8=
|alternate_link8=
|alternate_image9=
|alternate_name9=
|alternate_link9=
|alternate_image10=
|alternate_name10=
|alternate_link10=
|alternate_image11=
|alternate_name11=
|alternate_link11=
|alternate_image12=
|alternate_name12=
|alternate_link12=
|alternate_image13=
|alternate_name13=
|alternate_link13=
|alternate_image14=
|alternate_name14=
|alternate_link14=
|alternate_image15=
|alternate_name15=
|alternate_link15=
|alternate_image16=
|alternate_name16=
|alternate_link16=
<!--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=
<!--TECHNICAL DETAILS-->
|item_id =
}}

Parameters

Heading/Image

display_name
The display name of the item as it appears in-game. Leaving blank will display the pagename.
name_colour
The background colour for the display name. Codes can be found at Template:Infobox nc.
name_text_colour
The text colour for the display name. Codes can be found at Template:Infobox nc.
image
An image of the icon displayed at 128px by default. An image of the static model should be used if available.
image_width
Customise the width of the image.
alternate_image
An alternate image displayed at 32px. Can be an empty, packaged, open or any other variant.
alternate_name
The name of the alternate item image. Leaving blank will display no name when the image is hovered over.
alternate_link
An optional link to the alternate image page. Leaving blank will have no link.

General

weight
The base weight of the item.
category
The in-game category the item is displayed in in the inventory.
function
What the item is used for. Can usually be removed if the item isn't considered a tool by the wiki. (remove if value is empty)
max_units
The maximum units in a full item. Calculated using the "UseDelta" value: 1 / UseDelta.
packaged
Whether this item is considered to be "packaged", displaying the item's nutritional values. (remove if value is false)
cant_be_frozen
Whether this item can be frozen, delaying time before the food rots. (remove if value is false)
days_fresh
The amount of days this item is recognised as "fresh". The unit "days" is appended after the value. This value can be taken from DaysFresh in the scripts file. (remove if value is empty)
days_rotten
The amount of days before this item is recognised as "rotten". The unit "days" is appended after the value. This value can be taken from DaysTotallyRotten in the scripts file. (remove if value is empty)

Nutritional values

hunger_change
The value of hunger that is changed from using/consuming this item. (remove if value is empty)
thirst_change
The value of thirst that is changed from using/consuming this item. (remove if value is empty)
calories
The value of calories.
lipids
The value of lipids.
proteins
The value of proteins.
carbohydrates
The value of carbohydrates.

Effect

unhappy_change
The value of unhappiness that is changed from using/consuming this item. (remove if value is empty)
boredom_change
The value of boredom that is changed from using/consuming this item. (remove if value is empty)
stress_change
The value of stress that is changed from using/consuming this item. (remove if value is empty)
fatigue_change
The value of fatigue that is changed from using/consuming this item. (remove if value is empty)
endurance_change
The value of endurance that is changed from using/consuming this item. (remove if value is empty)
flu_change
The value of flu/cold that is changed from using/consuming this item. (remove if value is empty)
pain_change
The value of pain that is changed from using/consuming this item. (remove if value is empty)
sick_change
The value of sickness that is changed from using/consuming this item. (remove if value is empty)
reduce_infection_power
How much the item reduces wound infection. (remove if value is empty)
alcohol_power
The alcohol power of this item when used on wounds. (remove if value is empty)
poison_power
The value of poison power attached to this item. (remove if value is empty)

Cooking

cook_minutes
How long it takes before this item is "cooked". The unit "minutes" is appended after the value. (remove if value is empty)
burn_minutes
How long it takes before this item is "burnt". The unit "minutes" is appended after the value. (remove if value is empty)
dangerous_uncooked
Whether this item is dangerous if it is consumed before cooking it. (remove if value is false)
bad_microwaved
Whether this item is of a poorer quality if it is cooked in a microwave. (remove if value is false)
good_hot
Whether this item is of a superior quality if it is consumed hot. (remove if value is false)
bad_cold
Whether this item is of a poorer quality if it is consumed cold. (remove if value is false)
spice
Whether this item is considered a "spice" in cooking recipes. (remove if value is false)

Technical details

class_name
The item's 'Item ID'.


Examples

Hot Cuppa infobox

Hot Cuppa
{{{display_name}}}
Hot Drink
General
Category Food
Encumbrance
Heavy Load
0.5
Can't be frozen True
Nutrition
Hunger
Hunger
-5
Thirst
Thirst
-50
Calories
Calories
4
Carbohydrates
Carbohydrates
0.75
Proteins
Proteins
0.12
Fat
Fat
0
Effect
Unhappiness
Unhappiness
-5
Stress
Stress
-10
Fatigue
Tired
-5
Technical details
Item ID Item IDs


{{Infobox food
|name =Hot Cuppa
|name_colour=Drink
|name_text_colour=Drink
|image=MugBlue_Model.png
|image_width=220px
|alternate_image=MugFulll.png
|alternate_name=Hot Drink
|alternate_link=
|weight=0.5
|category=Food
|hunger_change=-5
|thirst_change=-50
|calories=4
|lipids=0
|proteins=0.12
|carbohydrates=0.75
|unhappy_change=-5
|stress_change=-10
|fatigue_change=-5
|cant_be_frozen=True
|item_id =Base.Mugfull
}}

Pot of Soup infobox

Pot of Soup
{{{display_name}}}
Pot of Soup
General
Category Food
Encumbrance
Heavy Load
4
Days until stale 3 days
Days until rotten 5 days
Nutrition
Hunger
Hunger
-30
Thirst
Thirst
-30
Calories
Calories
202
Carbohydrates
Carbohydrates
25
Proteins
Proteins
14
Fat
Fat
4.5
Effect
Unhappiness
Unhappiness
-20
Cooking
Time until cooked 50 minutes
Time until burned 100 minutes
Technical details
Item ID Item IDs


{{Infobox food
|name =Pot of Soup
|name_colour=Food
|name_text_colour=Food
|image=CookingPot_Model.png
|image_width=160px
|alternate_image=PotFull.png
|alternate_name=Pot of Soup
|alternate_link=Pot of Soup
|weight=4
|category=Food
|hunger_change=-30
|thirst_change=-30
|calories=202
|carbohydrates = 25
|proteins = 14
|lipids = 4.5
|unhappy_change=-20
|cook_minutes=50
|burn_minutes=100
|days_fresh=3
|days_rotten=5
|item_id =Base.PotOfSoup
}}

Lollipop infobox

Lollipop
{{{display_name}}}
Lollipop Candy Package
General
Category Food
Encumbrance
Heavy Load
0.1
Nutrition
Hunger
Hunger
-5
Calories
Calories
40
Carbohydrates
Carbohydrates
10
Proteins
Proteins
0
Fat
Fat
0.5
Effect
Unhappiness
Unhappiness
-10
Technical details
Item ID Item IDs


{{Infobox food
|name =Lollipop
|name_colour=Food
|name_text_colour=Food
|image=Lollipop_Model.png
|image_width=150px
|alternate_image=Lollipop.png
|alternate_name=Lollipop
|alternate_link=Lollipop
|alternate_image2=CandyPackagei.png
|alternate_name2=Candy Package
|alternate_link2=Candy Package
|weight=0.1
|category=Food
|hunger_change=-5
|unhappy_change=-10
|calories=40
|carbohydrates = 10
|proteins = 0
|lipids = 0.5
|item_id =Base.Lollipop
}}

Meat Patty infobox

Meat Patty
{{{display_name}}}
Meat Patty Meat Patty (Rotten) Meat Patty (Cooked) Meat Patty (Burnt)
General
Category Food
Encumbrance
Heavy Load
0.3
Days until stale 2 days
Days until rotten 4 days
Nutrition
Hunger
Hunger
-40
Calories
Calories
380
Carbohydrates
Carbohydrates
0
Proteins
Proteins
26
Fat
Fat
30
Cooking
Time until cooked 50 minutes
Time until burned 70 minutes
Bad microwaved True
Good hot True
Bad cold True
Technical details
Item ID Item IDs


{{Infobox food
|name =Meat Patty
|name_colour=Food
|name_text_colour=Food
|image=MeatPatty__Model.png
|image_width=150px
|alternate_image=MeatPatty.png
|alternate_name=Meat Patty
|alternate_link=
|alternate_image2=MeatPattyRotten.png
|alternate_name2=Meat Patty (Rotten)
|alternate_link2=
|alternate_image3=Cookedmeatpatty.png
|alternate_name3=Meat Patty (Cooked)
|alternate_link3=
|alternate_image4=Burnedmeatpatty.png
|alternate_name4=Meat Patty (Burnt)
|alternate_link4=
|weight=0.3
|category=Food
|hunger_change=-40
|calories=380
|carbohydrates = 0
|proteins = 26
|lipids = 30
|cook_minutes=50
|burn_minutes=70
|bad_microwaved=True
|good_hot=True
|bad_cold=True
|days_fresh=2
|days_rotten=4
|item_id =Base.MeatPatty
}}

Bourbon infobox

Bourbon
{{{display_name}}}
Bourbon Empty Bottle
General
Category Food
Encumbrance
Heavy Load
0.7
Can't be frozen True
Nutrition
Hunger
Hunger
-20
Thirst
Thirst
-20
Calories
Calories
1500
Carbohydrates
Carbohydrates
0
Proteins
Proteins
0
Fat
Fat
0
Effect
Unhappiness
Unhappiness
-10
Alcohol
Drunk
2
Technical details
Item ID Item IDs


{{Infobox food
|name =Bourbon
|name_colour=Drink
|name_text_colour=Drink
|image=WhiskeyBottle_Model.png
|image_width=200px
|alternate_image=WhiskeyFull.png
|alternate_link=Bourbon
|alternate_name=Bourbon
|alternate_image2=WhiskeyEmpty.png
|alternate_link2=Water Bottle (Bourbon)
|alternate_name2=Empty Bottle
|weight=0.7
|category=Food
|packaged_True
|cant_be_frozen=True
|hunger_change=-20
|thirst_change=-20
|calories=1500
|carbohydrates = 0
|proteins = 0
|lipids = 0
|unhappy_change=-10
|alcohol_power=2
|item_id =Base.WhiskeyFull
}}

Bleach infobox

Bleach
{{{display_name}}}
Bleach Empty Bleach Bottle
General
Category Household
Encumbrance
Heavy Load
0.3
Empty: 0.1
Nutrition
Thirst
Thirst
-60
Effect
Unhappiness
Unhappiness
99
Poison
SkullPoison.png
120
Technical details
Item ID Item IDs


{{Infobox food
|name =Bleach
|name_colour=Drink
|name_text_colour=Drink
|image=Bleach_Model.png
|image_width=200px
|alternate_image=Bleach.png
|alternate_name=Bleach
|alternate_link=
|alternate_image2=Bleach.png
|alternate_name2=Empty Bleach Bottle
|alternate_link2=
|weight=0.3<br>Empty: 0.1
|category=Household
|thirst_change=-60
|unhappy_change=99
|poison_power=120
|use_for_poison=38
|item_id =Base.Bleach
}}