3,890
edits
m
update usage info and TemplateData
No edit summary |
m (update usage info and TemplateData) |
||
Line 51: | Line 51: | ||
--> | --> | ||
This template generates entire pages for individual pieces of equipment in the game, such as [[Studded Leather Armour +1]] or [[Amulet of Misty Step]]. | This template generates entire pages for individual pieces of equipment in the game, such as [[Studded Leather Armour +1]] or [[Amulet of Misty Step]]. Supported Equipment types: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings. For Weapons, use [[Template:WeaponPage]]. For Consumables and other miscellaneous items, use [[Template:MiscItemPage]]. | ||
Following is an example of usage with all possible template parameters shown. This describes a completely made-up uncommon Leather Armour with an AC of 12 and a couple special properties. | Following is an example of usage with all possible template parameters shown. This describes a completely made-up uncommon Leather Armour with an AC of 12 and a couple special properties. | ||
Line 83: | Line 83: | ||
See here for the result of the above: [[Template:EquipmentPage/Example]] | See here for the result of the above: [[Template:EquipmentPage/Example]] | ||
Auto-generated TemplateData follows from this point on. | |||
---- | |||
[[Category:Equipment Page Templates]] | [[Category:Equipment Page Templates]] | ||
Line 90: | Line 92: | ||
"params": { | "params": { | ||
"image": { | "image": { | ||
"description": " | "description": "The filename of the image/icon associated with this item.", | ||
"example": "Amulet of Misty Step Icon.png", | "example": "Amulet of Misty Step Icon.png", | ||
"type": "wiki-file-name", | "type": "wiki-file-name", | ||
"suggested": true | "suggested": true | ||
}, | }, | ||
"description": {}, | "description": { | ||
"quote": {}, | "description": "The first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy.", | ||
"where to find": {}, | "example": "{{uncommon|Amulet of Misty Step}} is an uncommon [[Amulets|Amulet]] that allows the wearer to cast [[Misty Step]].", | ||
"type": {}, | "type": "content", | ||
"proficiency": {}, | "required": true, | ||
"armourclass": {}, | "suggested": true | ||
"armourclassbonus": {}, | }, | ||
"stealth disadvantage": {}, | "quote": { | ||
"rarity": {}, | "description": "The in-game flavour text in the item's tooltip.", | ||
"enchantment": {}, | "type": "content", | ||
"weight kg": {}, | "suggested": true | ||
"weight lb": {}, | }, | ||
"price": {}, | "where to find": { | ||
"special": { | "description": "Describe where and how to obtain the item.", | ||
"example": "Looted from [[NPC Name]] in [[Location]].", | |||
"type": "content", | |||
"suggested": true | |||
}, | |||
"type": { | |||
"description": "Item type. Choose one of: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings", | |||
"type": "string", | |||
"required": true, | |||
"suggested": true, | |||
"suggestedvalues": [ | |||
"Clothing", | |||
"Light Armour", | |||
"Medium Armour", | |||
"Heavy Armour", | |||
"Shields", | |||
"Amulets", | |||
"Belts", | |||
"Boots", | |||
"Cloaks", | |||
"Gloves", | |||
"Helmets", | |||
"Rings" | |||
] | |||
}, | |||
"proficiency": { | |||
"description": "Leave EMPTY if no proficiency required, otherwise choose from: Light Armour, Medium Armour, Heavy Armour, Shields", | |||
"type": "string", | |||
"suggestedvalues": [ | |||
"Light Armour", | |||
"Medium Armour", | |||
"Heavy Armour", | |||
"Shields" | |||
], | |||
"suggested": true | |||
}, | |||
"armourclass": { | |||
"description": "Leave EMPTY for non-Armour, otherwise: the Armour Class value displayed on the Armour's tooltip.", | |||
"example": "12", | |||
"type": "number", | |||
"suggested": true | |||
}, | |||
"armourclassbonus": { | |||
"description": "Leave EMPTY for non-Shields, otherwise: the bonus to AC granted by wearing this item, e.g.: +2, +3, +4", | |||
"example": "+2", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"stealth disadvantage": { | |||
"description": "Does this item grant disadvantage on stealth checks? LEAVE EMPTY if no!", | |||
"type": "string", | |||
"suggestedvalues": [ | |||
"yes" | |||
], | |||
"suggested": true | |||
}, | |||
"rarity": { | |||
"description": "Choose from: common, uncommon, rare, very rare, legendary, story", | |||
"type": "string", | |||
"suggestedvalues": [ | |||
"common", | |||
"uncommon", | |||
"rare", | |||
"very rare", | |||
"legendary", | |||
"story" | |||
], | |||
"required": true, | |||
"suggested": true | |||
}, | |||
"enchantment": { | |||
"description": "The enchantment value on the item. Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5", | |||
"example": "+1", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"weight kg": { | |||
"description": "Weight of the item in kilograms", | |||
"type": "number", | |||
"required": true, | |||
"suggested": true | |||
}, | |||
"weight lb": { | |||
"description": "Weight of the item in pounds", | |||
"type": "number", | |||
"required": true, | |||
"suggested": 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, | |||
"suggested": true | |||
}, | |||
"special": { | |||
"description": "List of special features, bonuses, or abilities granted by the item.", | |||
"example": "* '''Super Cool Ability:''' Once per [[Long Rest]] you can use this awesome ability of this item.", | |||
"type": "content", | |||
"suggested": true | |||
} | |||
}, | }, | ||
"description": "This template generates entire pages for individual pieces of equipment in the game, | "description": "This template generates entire pages for individual pieces of equipment in the game. Supported Equipment types: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings. (For Weapons, use Template:WeaponPage. For Consumables and other miscellaneous items, use Template:MiscItemPage.)\n\nCopy example values exactly as listed, including capitalization and plurals, if any. If you're ever unsure what to type, simply leave the parameter empty.", | ||
"format": "block" | |||
} | } | ||
</templatedata></noinclude> | </templatedata></noinclude> |