Template:Food Infobox/doc

From Anvil Empires Wiki
Jump to navigation Jump to search
Template-info.svg Documentation

Usage

{{Food Infobox
|IsReleasedAndEnabled=
|ContentLang=
|CodeNameString=
|NameText=
|Icon=
|ItemTags=
|RegenPerSec=
|RegenDuration=
|ConversionRatioToFood=
|FoodType=
|SpoilageDurabilityLossPerSec=
|HungerRestored=
|HealthLimitRestored=
|StaminaLimitRestored=
|DescriptionText=
|DescriptionFooterText=
}}

Details

This template is used by all Food.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
IsReleasedAndEnabledIsReleasedAndEnabled

If this food is an active item in the current build or if its upcoming or removed from the game.

Default
Yes
Example
No
Booleansuggested
ContentLangContentLang

Content Language, legacy field from before the french wiki split.

Default
en
Stringsuggested
CodeNameStringCodeNameString

Game codename for the item, used as the primary ID.

Example
BerryRations
Stringrequired
NameTextNameText

Ingame name for the item

Default
{{PAGENAME}}
Stringrequired
IconIcon

Game icon image for the food, is set to a default image if none is set.

Default
DefaultImage.png
Example
IconBerryRation.png
Stringsuggested
ItemTagsItemTags

Comma split string list of tags, used for item inventory filtering.

Example
PrimaryTool,StorableFoodT1,Stackable
Stringsuggested
RegenPerSecRegenPerSec

Health regeneration rate per second.

Numbersuggested
RegenDurationRegenDuration

Health regeneration duration.

Numbersuggested
ConversionRatioToFoodConversionRatioToFood

TODO

Numberoptional
FoodTypeFoodType

Food type/group. I.e Berries, Produce, Fish, Common Meat, Deer Meat, Boar Meat.

Numberoptional
SpoilageDurabilityLossPerSecSpoilageDurabilityLossPerSec

TODO

Numberoptional
HungerRestoredHungerRestored

Amount of hunger restored.

Numberoptional
HealthLimitRestoredHealthLimitRestored

Amount of health restored.

Numberoptional
StaminaLimitRestoredStaminaLimitRestored

Amount of stamina restored.

Numberoptional
DescriptionTextDescriptionText

Parse through value of the ingame description for the item, placed at the top of the food page.

Stringsuggested
DescriptionFooterTextDescriptionFooterText

Parse through value of the ingame description footer for the item, placed at the top of the food page.

Stringsuggested
This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.