Template:Infobox food/doc: Difference between revisions

From PZwiki
mNo edit summary
mNo edit summary
Line 24: Line 24:
|alternate_name3=alternate_name3
|alternate_name3=alternate_name3
|alternate_link3=
|alternate_link3=
|alternate_image4=image.png{{!}}32px
|alternate_name4=alternate_name3
|alternate_link4=
|alternate_image5=image.png{{!}}32px
|alternate_name5=alternate_name3
|alternate_link5=
<!--GENERAL-->
<!--GENERAL-->
|weight=weight
|weight=weight
Line 73: Line 79:
|alternate_name3=
|alternate_name3=
|alternate_link3=
|alternate_link3=
|alternate_image4=
|alternate_name4=
|alternate_link4=
|alternate_image5=
|alternate_name5=
|alternate_link5=
<!--GENERAL-->
<!--GENERAL-->
|category=
|category=
Line 402: Line 414:
|alternate_image=Bleach.png
|alternate_image=Bleach.png
|alternate_name=Empty Bleach Bottle
|alternate_name=Empty Bleach Bottle
|weight=0.3<br>Empty:0.1
|weight=0.3<br>Empty: 0.1
|category=Item
|category=Item
|thirst_change=-60
|thirst_change=-60

Revision as of 14:35, 7 March 2019

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.

display_name
display_name
alternate_name alternate_name2 alternate_name3 alternate_name3 alternate_name3
General
Category category
Encumbrance
Heavy Load
weight
Function function
Days until stale 4 days
Days until rotten 6 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
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 class_name
{{Infobox food
|display_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=
<!--GENERAL-->
|category=
|weight=
|function=
|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=
|reduce_infection_power=
|alcohol_power=
|poison_power=
<!--COOKING-->
|cook_minutes=
|burn_minutes=
|dangerous_uncooked=
|bad_microwaved=
|good_hot=
|bad_cold=
|spice=
<!--TECHNICAL DETAILS-->
|class_name=
}}

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 120px. A 120px variant should be used if it has one.
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)
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. (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. (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. (remove if value is empty)
lipids
The value of lipids. (remove if value is empty)
proteins
The value of proteins. (remove if value is empty)
carbohydrates
The value of carbohydrates. (remove if value is empty)

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)
reduce_infection_power
How much the item reduces wound infection. Currently only present on antibiotics. (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 class name.


Examples

Hot Cuppa infobox

Hot Cuppa
Hot Cuppa
Empty Mug
General
Category Food
Encumbrance
Heavy Load
1
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 Base.Mugfulll
{{Infobox food
|display_name=Hot Cuppa
|name_colour=Drink
|name_text_colour=Drink
|image=MugFulll_120px.png
|alternate_image=Mugl.png
|alternate_name=Empty Mug
|alternate_link=Empty Mug
|weight=1
|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
|class_name=Base.Mugfulll
}}

Pot of Soup infobox

Pot of Soup
Pot of Soup
Cooking Pot
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
125
Carbohydrates
Carbohydrates
20
Proteins
Proteins
7.5
Fat
Fat
2.5
Effect
Unhappiness
Unhappiness
-20
Boredom
Boredom
-10
Cooking
Time until cooked 50 minutes
Time until burned 100 minutes
Technical details
Item ID Base.PotOfSoup
{{Infobox food
|display_name=Pot of Soup
|name_colour=Food
|name_text_colour=Food
|image=PotFull_120px.png
|alternate_image=Pot.png
|alternate_name=Cooking Pot
|alternate_link=Cooking Pot
|weight=4
|category=Food
|hunger_change=-30
|thirst_change=-30
|calories=125
|carbohydrates = 20
|proteins = 7.5
|lipids = 2.5
|unhappy_change=-20
|boredom_change=-10
|cook_minutes=50
|burn_minutes=100
|days_fresh=3
|days_rotten=5
|class_name=Base.PotOfSoup
}}

Lollipop infobox

Lollipop
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 Base.Lollipop
{{Infobox food
|display_name=Lollipop
|name_colour=Food
|name_text_colour=Food
|image=Lollipop_120px.png
|alternate_image=CandyPackagei.png
|alternate_name=Candy Package
|weight=0.1
|category=Food
|hunger_change=-5
|unhappy_change=-10
|calories=40
|carbohydrates = 10
|proteins = 0
|lipids = 0.5
|class_name=Base.Lollipop
}}

Meat Patty infobox

Meat Patty
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 Base.MeatPatty
{{Infobox food
|display_name=Meat Patty
|name_colour=Food
|name_text_colour=Food
|image=MeatPatty_120px.png
|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
|class_name=Base.MeatPatty
}}

Bourbon infobox

Whiskey Bottle
Whiskey Bottle
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 Base.WhiskeyFull
{{Infobox food
|display_name=Whiskey Bottle
|name_colour=Drink
|name_text_colour=Drink
|image=WhiskeyFull_120px.png
|alternate_image=WhiskeyEmpty.png
|alternate_link=Empty Bottle (Alcohol)
|alternate_name=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
|class_name=Base.WhiskeyFull
}}

Bleach infobox

Bleach
Bleach
Empty Bleach Bottle
General
Category Item
Encumbrance
Heavy Load
0.3
Empty: 0.1
Nutrition
Thirst
Thirst
-60
Effect
Unhappiness
Unhappiness
99
Poison
SkullPoison.png
40
Technical details
Item ID Base.Bleach
{{Infobox food
|display_name=Bleach
|name_colour=Drink
|name_text_colour=Drink
|image=Bleach_120px.png
|alternate_image=Bleach.png
|alternate_name=Empty Bleach Bottle
|weight=0.3<br>Empty:0.1
|category=Item
|thirst_change=-60
|unhappy_change=99
|poison_power=40
|use_for_poison=15
|class_name=Base.Bleach
}}