Template:Infobox item/doc: Difference between revisions

From Coral Island Wiki
Jump to navigation Jump to search
No edit summary
(Added "description" field)
 
(3 intermediate revisions by 2 users not shown)
Line 6: Line 6:
|journal_id  = 6
|journal_id  = 6
|type        = Vegetable
|type        = Vegetable
|farm        = Land
|seed        = Carrot seeds
|seed        = Carrot seeds
|seed_price  = 35
|seed_price  = 35
Line 41: Line 42:
|diff_quality = 1
|diff_quality = 1
}}
}}
<templatedata>
{
"params": {
"type": {
"label": "Type",
"description": "Type shown in in-game details",
"example": "Vegetable",
"type": "string",
"suggestedvalues": [
"Vegetable",
"Fruit",
"Flower",
"Herb",
"Grain",
"Seed",
"Seedling",
"Cooked dish",
"Loot",
"Bomb",
"Decoy",
"Resource",
"Resource equipment",
"Artisan equipment",
"Artisan product",
"Animal product",
"Scavengeable",
"Mushroom",
"Bug",
"Ocean critter",
"Artifact",
"Fossil",
"Geode",
"Gem",
"Letter",
"Torn page",
"Tool",
"Weapon",
"Consumable",
"Bait",
"Trap",
"Fish",
"Misc",
"Farming",
"Ranch",
"Decor",
"Cooking utensil"
],
"suggested": true
},
"item_group": {
"label": "Item group",
"description": "Semicolon-separated list of gifting, and ingredient categories all in one",
"type": "string"
},
"journal": {
"label": "Journal category",
"description": "Journal side nav",
"type": "string"
},
"farm": {
"label": "Farm conditions",
"description": "Which farm can this be planted/used in",
"example": "Land",
"type": "string",
"suggestedvalues": [
"Land",
"Ocean"
]
},
"size": {
"label": "Size",
"description": "Footprint when placed on farm",
"example": "3x3",
"type": "string"
},
"season": {
"label": "Season(s)",
"description": "Semicolon-separated list of seasons a crop can be grown in, or \"All\"",
"example": "Spring;Summer",
"type": "string",
"suggestedvalues": [
"All"
]
},
"seed": {
"label": "Seed",
"description": "Seed that, when planted, produces this item.",
"type": "wiki-page-name"
},
"seed_price": {
"label": "Seed price",
"description": "How much this item's seed costs. Only displayed if \"Seed\" is set.",
"example": "20",
"type": "number"
},
"growth": {
"label": "Growth rate",
"description": "Number of days needed for this crop to grow to maturity",
"example": "5",
"type": "number"
},
"growth_note": {
"label": "Growth note",
"description": "Additional notes on growth. Only displayed if \"Growth rate\" is set.",
"type": "string"
},
"regrowth": {
"label": "Regrowth",
"description": "Number of days needed for this crop to regrow. Only displayed if \"Growth rate\" is set.",
"example": "2",
"type": "number"
},
"rank": {
"label": "Unlock Requirements: Town rank",
"description": "What town rank is required to unlock this item. Adds the page to the corresponding \"Town rank X\" category.",
"example": "A",
"type": "string",
"suggestedvalues": [
"S",
"A",
"B",
"C",
"D",
"E",
"F"
]
},
"year": {
"label": "Unlock Requirements: Year",
"description": "What year this item is unlocked. Only displayed if \"Unlock Requirements: Town rank. Adds the page to the corresponding \"Year X\" category.",
"example": "2",
"type": "number"
},
"building": {
"label": "Unlock Requirements: Building",
"description": "What building and upgrade level are required. Only displayed if \"Unlock Requirements: Town rank\" is set."
},
"mastery": {
"label": "Unlock Requirements: Mastery level",
"description": "Required mastery name, and optionally the required mastery level. Level is separated from the name by a semicolon.",
"example": "Farming;6",
"suggestedvalues": [
"Farming",
"Ranching",
"Foraging",
"Mining",
"Diving",
"Catching",
"Fishing",
"Combat"
]
},
"produced_by": {
"label": "Produced by",
"description": "What animal or equipment produces this item. If a png file exists with this name, it will be used as the image icon. Adds the page to the corresponding \"products\" category (birds -> \"Coop products\", barn animals -> \"Barn products\", others -> \"X products\"). Case sensitive!",
"example": "Pig",
"type": "string",
"suggestedvalues": [
"Chicken",
"Duck",
"Peafowl",
"Quail",
"Pig",
"Luwak",
"Goat",
"Cow",
"Llama",
"Sheep",
"Keg",
"Loom",
"Mason jar",
"Dehydrator",
"Aging barrel",
"Bee house",
"Cheese press",
"Mayonnaise machine",
"Mill",
"Oil press"
]
},
"produced_note": {
"label": "Produced by notes",
"description": "Additional details on the production of this item.",
"type": "string"
},
"source": {
"label": "Sources",
"description": "Semicolon-separated list of sources",
"type": "string"
},
"sell": {
"label": "Sell Price: Base",
"description": "Item's base sell price. If 0, displayed value will be \"Unsellable\"",
"example": "100",
"type": "number"
},
"diff_quality": {
"label": "Automatically calculate bronze/silver/gold/osmium values?",
"description": "If set to a non-empty value, automatically calculates missing sell, health and energy values. See \"Template:Sell prices\".",
"example": "1"
},
"bronze": {
"label": "Sell Price: Bronze",
"description": "If set, indicates the bronze sell price. If \"sell\" and \"diff_quality\" are both also set, this will override the auto-calculated value.",
"example": "1900",
"type": "number"
},
"silver": {
"label": "Sell Price: Silver",
"description": "If set, indicates the silver sell price. If \"sell\" and \"diff_quality\" are both also set, this will override the auto-calculated value.",
"example": "1900",
"type": "number"
},
"gold": {
"label": "Sell Price: Gold",
"description": "If set, indicates the bronze sell price. If \"sell\" and \"diff_quality\" are both also set, this will override the auto-calculated value.",
"example": "1900",
"type": "number"
},
"osmium": {
"label": "Sell Price: Osmium",
"description": "If set, indicates the bronze sell price. If \"sell\" and \"diff_quality\" are both also set, this will override the auto-calculated value.",
"example": "1900",
"type": "number"
},
"health": {
"label": "Restores Health: Base",
"description": "Amount of health consuming this item restores when it has no quality.",
"example": "10",
"type": "number"
},
"energy": {
"label": "Restores Energy: Base",
"description": "Amount of energy consuming this item restores when it has no quality. Only shown if the corresponding health value would be shown.",
"example": "10",
"type": "number"
},
"health_bronze": {
"label": "Restores Health: Bronze",
"description": "Amount of health consuming this item restores when it is bronze quality. If \"health\" and \"diff_quality\" are both also set, this will override the auto-calculated value.",
"example": "10",
"type": "number"
},
"energy_bronze": {
"label": "Restores Energy: Bronze",
"description": "Amount of energy consuming this item restores when it is bronze quality. If \"energy\" and \"diff_quality\" are both also set, this will override the auto-calculated value. Only shown if the corresponding health value would be shown."
},
"health_silver": {
"label": "Restores Health: Silver",
"description": "Amount of health consuming this item restores when it is silver quality. If \"health\" and \"diff_quality\" are both also set, this will override the auto-calculated value.",
"example": "10",
"type": "number"
},
"energy_silver": {
"label": "Restores Energy: Silver",
"description": "Amount of energy consuming this item restores when it is silver quality. If \"energy\" and \"diff_quality\" are both also set, this will override the auto-calculated value. Only shown if the corresponding health value would be shown.",
"example": "10",
"type": "number"
},
"health_gold": {
"label": "Restores Health: Gold",
"description": "Amount of health consuming this item restores when it is gold quality. If \"health\" and \"diff_quality\" are both also set, this will override the auto-calculated value.",
"example": "10",
"type": "number"
},
"energy_gold": {
"label": "Restores Energy: Gold",
"description": "Amount of energy consuming this item restores when it is gold quality. If \"energy\" and \"diff_quality\" are both also set, this will override the auto-calculated value. Only shown if the corresponding health value would be shown.",
"example": "10",
"type": "number"
},
"health_osmium": {
"label": "Restores Health: Osmium",
"description": "Amount of health consuming this item restores when it is osmium quality. If \"health\" and \"diff_quality\" are both also set, this will override the auto-calculated value.",
"example": "10",
"type": "number"
},
"energy_osmium": {
"label": "Restores Energy: Osmium",
"description": "Amount of energy consuming this item restores when it is osmium quality. If \"energy\" and \"diff_quality\" are both also set, this will override the auto-calculated value. Only shown if the corresponding health value would be shown.",
"example": "10",
"type": "number"
},
"journal_id": {
"label": "Journal ID",
"description": "Position in the journal that this item appears in. Counting starts from \"01\" (zero padded) left-right top-bottom.",
"example": "09",
"type": "string",
"suggested": true
},
"category": {
"label": "Categories",
"description": "Semicolon-separated list of additional categories this page will be added to.",
"type": "string"
},
"giant_crop": {
"label": "Can be a giant crop?",
"example": "Yes",
"type": "string",
"suggestedvalues": [
"Yes",
"No"
]
},
"wild_seed": {
"label": "Can sprout from wild seeds?",
"example": "Yes",
"type": "string",
"suggestedvalues": [
"Yes",
"No"
]
},
"effect": {
"label": "Effects"
},
"enchanting": {
"label": "Enchanting value",
"description": "How much fuel does this item provide while enchanting?",
"example": "100",
"type": "number"
},
"description": {
"label": "Item Description",
"description": "In-game description. Displayed as the caption of the item's image, so will not be visible if there isn't an image file with the same name as the item."
}
},
"description": "Infobox for items",
"paramOrder": [
"description",
"type",
"item_group",
"journal",
"farm",
"size",
"season",
"seed",
"seed_price",
"growth",
"growth_note",
"regrowth",
"rank",
"year",
"building",
"mastery",
"produced_by",
"produced_note",
"source",
"diff_quality",
"sell",
"bronze",
"silver",
"gold",
"osmium",
"health",
"health_bronze",
"health_silver",
"health_gold",
"health_osmium",
"energy",
"energy_bronze",
"energy_silver",
"energy_gold",
"energy_osmium",
"journal_id",
"category",
"giant_crop",
"wild_seed",
"effect",
"enchanting"
],
"format": "block"
}
</templatedata>

Latest revision as of 17:35, 23 August 2024

This is the documentation page for Infobox item.
It contains usage information, categories, and other content not part of the original template page.

Example 1

Example 2

Example 3

Infobox for items

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Item Descriptiondescription

In-game description. Displayed as the caption of the item's image, so will not be visible if there isn't an image file with the same name as the item.

Unknownoptional
Typetype

Type shown in in-game details

Suggested values
Vegetable Fruit Flower Herb Grain Seed Seedling Cooked dish Loot Bomb Decoy Resource Resource equipment Artisan equipment Artisan product Animal product Scavengeable Mushroom Bug Ocean critter Artifact Fossil Geode Gem Letter Torn page Tool Weapon Consumable Bait Trap Fish Misc Farming Ranch Decor Cooking utensil
Example
Vegetable
Stringsuggested
Item groupitem_group

Semicolon-separated list of gifting, and ingredient categories all in one

Stringoptional
Journal categoryjournal

Journal side nav

Stringoptional
Farm conditionsfarm

Which farm can this be planted/used in

Suggested values
Land Ocean
Example
Land
Stringoptional
Sizesize

Footprint when placed on farm

Example
3x3
Stringoptional
Season(s)season

Semicolon-separated list of seasons a crop can be grown in, or "All"

Suggested values
All
Example
Spring;Summer
Stringoptional
Seedseed

Seed that, when planted, produces this item.

Page nameoptional
Seed priceseed_price

How much this item's seed costs. Only displayed if "Seed" is set.

Example
20
Numberoptional
Growth rategrowth

Number of days needed for this crop to grow to maturity

Example
5
Numberoptional
Growth notegrowth_note

Additional notes on growth. Only displayed if "Growth rate" is set.

Stringoptional
Regrowthregrowth

Number of days needed for this crop to regrow. Only displayed if "Growth rate" is set.

Example
2
Numberoptional
Unlock Requirements: Town rankrank

What town rank is required to unlock this item. Adds the page to the corresponding "Town rank X" category.

Suggested values
S A B C D E F
Example
A
Stringoptional
Unlock Requirements: Yearyear

What year this item is unlocked. Only displayed if "Unlock Requirements: Town rank. Adds the page to the corresponding "Year X" category.

Example
2
Numberoptional
Unlock Requirements: Buildingbuilding

What building and upgrade level are required. Only displayed if "Unlock Requirements: Town rank" is set.

Unknownoptional
Unlock Requirements: Mastery levelmastery

Required mastery name, and optionally the required mastery level. Level is separated from the name by a semicolon.

Suggested values
Farming Ranching Foraging Mining Diving Catching Fishing Combat
Example
Farming;6
Unknownoptional
Produced byproduced_by

What animal or equipment produces this item. If a png file exists with this name, it will be used as the image icon. Adds the page to the corresponding "products" category (birds -> "Coop products", barn animals -> "Barn products", others -> "X products"). Case sensitive!

Suggested values
Chicken Duck Peafowl Quail Pig Luwak Goat Cow Llama Sheep Keg Loom Mason jar Dehydrator Aging barrel Bee house Cheese press Mayonnaise machine Mill Oil press
Example
Pig
Stringoptional
Produced by notesproduced_note

Additional details on the production of this item.

Stringoptional
Sourcessource

Semicolon-separated list of sources

Stringoptional
Automatically calculate bronze/silver/gold/osmium values?diff_quality

If set to a non-empty value, automatically calculates missing sell, health and energy values. See "Template:Sell prices".

Example
1
Unknownoptional
Sell Price: Basesell

Item's base sell price. If 0, displayed value will be "Unsellable"

Example
100
Numberoptional
Sell Price: Bronzebronze

If set, indicates the bronze sell price. If "sell" and "diff_quality" are both also set, this will override the auto-calculated value.

Example
1900
Numberoptional
Sell Price: Silversilver

If set, indicates the silver sell price. If "sell" and "diff_quality" are both also set, this will override the auto-calculated value.

Example
1900
Numberoptional
Sell Price: Goldgold

If set, indicates the bronze sell price. If "sell" and "diff_quality" are both also set, this will override the auto-calculated value.

Example
1900
Numberoptional
Sell Price: Osmiumosmium

If set, indicates the bronze sell price. If "sell" and "diff_quality" are both also set, this will override the auto-calculated value.

Example
1900
Numberoptional
Restores Health: Basehealth

Amount of health consuming this item restores when it has no quality.

Example
10
Numberoptional
Restores Health: Bronzehealth_bronze

Amount of health consuming this item restores when it is bronze quality. If "health" and "diff_quality" are both also set, this will override the auto-calculated value.

Example
10
Numberoptional
Restores Health: Silverhealth_silver

Amount of health consuming this item restores when it is silver quality. If "health" and "diff_quality" are both also set, this will override the auto-calculated value.

Example
10
Numberoptional
Restores Health: Goldhealth_gold

Amount of health consuming this item restores when it is gold quality. If "health" and "diff_quality" are both also set, this will override the auto-calculated value.

Example
10
Numberoptional
Restores Health: Osmiumhealth_osmium

Amount of health consuming this item restores when it is osmium quality. If "health" and "diff_quality" are both also set, this will override the auto-calculated value.

Example
10
Numberoptional
Restores Energy: Baseenergy

Amount of energy consuming this item restores when it has no quality. Only shown if the corresponding health value would be shown.

Example
10
Numberoptional
Restores Energy: Bronzeenergy_bronze

Amount of energy consuming this item restores when it is bronze quality. If "energy" and "diff_quality" are both also set, this will override the auto-calculated value. Only shown if the corresponding health value would be shown.

Unknownoptional
Restores Energy: Silverenergy_silver

Amount of energy consuming this item restores when it is silver quality. If "energy" and "diff_quality" are both also set, this will override the auto-calculated value. Only shown if the corresponding health value would be shown.

Example
10
Numberoptional
Restores Energy: Goldenergy_gold

Amount of energy consuming this item restores when it is gold quality. If "energy" and "diff_quality" are both also set, this will override the auto-calculated value. Only shown if the corresponding health value would be shown.

Example
10
Numberoptional
Restores Energy: Osmiumenergy_osmium

Amount of energy consuming this item restores when it is osmium quality. If "energy" and "diff_quality" are both also set, this will override the auto-calculated value. Only shown if the corresponding health value would be shown.

Example
10
Numberoptional
Journal IDjournal_id

Position in the journal that this item appears in. Counting starts from "01" (zero padded) left-right top-bottom.

Example
09
Stringsuggested
Categoriescategory

Semicolon-separated list of additional categories this page will be added to.

Stringoptional
Can be a giant crop?giant_crop

no description

Suggested values
Yes No
Example
Yes
Stringoptional
Can sprout from wild seeds?wild_seed

no description

Suggested values
Yes No
Example
Yes
Stringoptional
Effectseffect

no description

Unknownoptional
Enchanting valueenchanting

How much fuel does this item provide while enchanting?

Example
100
Numberoptional