3,890
edits
m
add TemplateData documentation
m (WIP) |
m (add TemplateData documentation) |
||
Line 72: | Line 72: | ||
See here for the result of the above: [[Template:MiscItemPage/Example]] | See here for the result of the above: [[Template:MiscItemPage/Example]] | ||
[[Category:Item Page Templates]]</noinclude> | [[Category:Item Page Templates]]<templatedata> | ||
{ | |||
"params": { | |||
"image": { | |||
"description": "The filename of the image/icon associated with this item.", | |||
"example": "Potion of Fire Resistance Icon.png", | |||
"type": "wiki-file-name", | |||
"suggested": true | |||
}, | |||
"description": { | |||
"description": "This is the first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy.", | |||
"example": "{{uncommon|Potion of Stuff}} is an uncommon [[Potions|Potion]] that grants +1 to Stuff.", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"quote": { | |||
"description": "The in-game flavour text in the item's tooltip.", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"book text": { | |||
"description": "The text within the book. Leave EMPTY for non-books - use \"quote\" parameter for tooltip flavour text.", | |||
"type": "content" | |||
}, | |||
"where to find": { | |||
"description": "Describe where and how to obtain the item.", | |||
"example": "Looted from [[NPC]] in [[Location]].", | |||
"type": "content", | |||
"suggested": true | |||
}, | |||
"type": { | |||
"aliases": [ | |||
"item type" | |||
], | |||
"description": "Item type. Choose one of: Ammunition, Books, Food, Drinks, Potions, Scrolls, Consumables, Misc", | |||
"type": "string", | |||
"suggestedvalues": [ | |||
"Ammunition", | |||
"Books", | |||
"Food", | |||
"Drinks", | |||
"Potions", | |||
"Scrolls", | |||
"Consumables", | |||
"Misc" | |||
], | |||
"required": true | |||
}, | |||
"camp supplies": { | |||
"description": "Number of Camp Supplies. Leave EMPTY for all except Food and Drinks.", | |||
"type": "number" | |||
}, | |||
"rarity": { | |||
"description": "Rarity of the item. Choose from: common, uncommon, rare, very rare, legendary, story", | |||
"type": "string", | |||
"suggestedvalues": [ | |||
"common", | |||
"uncommon", | |||
"rare", | |||
"very rare", | |||
"legendary", | |||
"story" | |||
], | |||
"default": "common", | |||
"autovalue": "common", | |||
"required": true | |||
}, | |||
"weight kg": { | |||
"description": "Weight of the item in kilograms", | |||
"type": "number", | |||
"required": true | |||
}, | |||
"weight lb": { | |||
"description": "Weight of the item in pounds", | |||
"type": "number", | |||
"required": true | |||
}, | |||
"price": { | |||
"description": "Price/value of the item. When two values are listed on the tooltip, use the crossed out \"true\" value, not the adjusted buy/sell price.", | |||
"type": "number", | |||
"required": true | |||
}, | |||
"special": { | |||
"description": "Any special effects of the item not already included in other template properties.", | |||
"example": "* Grants +1 to [[Stuff]] until next [[Long Rest]]", | |||
"type": "content", | |||
"suggested": true | |||
} | |||
}, | |||
"description": "This template generates entire pages for individual items of the following types: Ammunition, Books, Food, Drinks, Potions, Scrolls, Consumables, and other Miscellaneous Items. For Weapons, see Template:WeaponPage. For Equipment, see Template:EquipmentPage.", | |||
"format": "block" | |||
} | |||
</templatedata></noinclude> |