|
|
Line 90: |
Line 90: |
| |image={{{image|}}} | | |image={{{image|}}} |
| |rarity={{{rarity|common}}} | | |rarity={{{rarity|common}}} |
| }}</includeonly><noinclude><!-- | | }}{{#switch: {{{this is an example|}}} |
| | | | yes = |
| ==== Documentation follows ====
| | | #default = {{#cargo_store: _table = equipment |
| | | | name = {{{name | {{#titleparts: {{PAGENAME}} }} }}} |
| -->
| | | legacy = {{#var:legacy}} <!-- Intentionally using a page-scope var to pick up information from a different template. --> |
| 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, Boots, Cloaks, Gloves, Helmets, Rings, Camp Clothes, Camp Shoes, Undergarments. For Weapons, use [[Template:WeaponPage]]. For Consumables and other miscellaneous items, use [[Template:MiscItemPage]].
| | | proficiency = {{{proficiency|}}} |
| | | | stealth_disadvantage = {{IfEmpty | {{{stealth disadvantage|}}} | no}} |
| '''See the bottom of this page for template parameter explanations. If you're ever unsure what to type, simply leave a parameter empty (don't remove it, as this may confuse other wiki editors).'''
| | | rarity = {{IfEmpty | {{{rarity|}}} | common}} |
| | | | rarity_order = {{#switch: {{{rarity|}}} |
| <pre>
| | | | common = 0 |
| {{EquipmentPage | | | uncommon = 1 |
| | | | rare = 2 |
| <!-- High-res image of the item. -->
| | | very rare = 3 |
| | image =
| | | legendary = 4 |
| | | | story = 5 |
| <!-- Icon for the item. Falls back to the value of "image" if not specified. -->
| | }} |
| | icon =
| |
| | |
| <!-- This is the first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy. -->
| |
| | description = | |
| | |
| <!-- The in-game flavor text in the item's tooltip. -->
| |
| | quote = | |
| | |
| <!-- Item type. Choose one of: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings -->
| |
| | type = | |
| | |
| <!-- Leave EMPTY if no proficiency needed, otherwise choose from: Light Armour, Medium Armour, Heavy Armour, Shields -->
| |
| | proficiency =
| |
| | |
| <!-- Leave EMPTY for non-Armour, otherwise: the Armour Class value displayed on the armour's tooltip. -->
| |
| | armour class = | |
| | |
| <!-- Leave EMPTY for non-Shields, otherwise: the bonus to AC granted by wearing this item, e.g.: +2, +3, +4 -->
| |
| | armour class bonus = | |
| | |
| <!-- Does this item grant disadvantage on stealth checks? LEAVE EMPTY if no! -->
| |
| | stealth disadvantage =
| |
| | |
| <!-- Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5 -->
| |
| | enchantment = | |
| | |
| <!-- Choose from: common, uncommon, rare, very rare, legendary, story -->
| |
| | rarity =
| |
| | |
| <!-- Weight in kg and in lb. --> | |
| | weight kg =
| |
| | weight lb =
| |
| | |
| <!-- Price in gp as shown in the normal tooltip (NOT while buying or selling). -->
| |
| | price =
| |
| | |
| <!-- The UID for the item in format "OBJ_ItemName_BlaBla" -->
| |
| | uid =
| |
| <!-- The uuid or root template for the item. Often in format 13776348-0101-446e-a9f8-c95efb3763ca -->
| |
| | uuid = | |
| | |
| <!-- List of special features, bonuses, or abilities granted by the item. -->
| |
| | special =
| |
| | |
| <!-- Conditions given by this piece of equipment. -->
| |
| | condition = Dazed
| |
| | condition duration = 10
| |
| | condition save = WIS
| |
| | condition dc = 13
| |
| | condition2 = Prone
| |
| | condition2 duration = 1
| |
| | condition2 save =
| |
| | condition2 dc =
| |
| | |
| <!-- Describe where and how to obtain the item. -->
| |
| | where to find =
| |
| | |
| }}
| |
| </pre>
| |
| | |
| Copy-ready:
| |
| <pre>
| |
| {{EquipmentPage | |
| | image =
| |
| | icon =
| |
| | description =
| |
| | quote =
| |
| <!-- Item type. Choose one of: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings -->
| |
| | type =
| |
| | proficiency =
| |
| | armour class = | |
| | armour class bonus = | |
| | stealth disadvantage = | |
| | enchantment = | |
| | rarity = | |
| | weight kg = | |
| | weight lb = | |
| | price = | |
| | uid =
| |
| | uuid =
| |
| | special =
| |
| | condition =
| |
| | condition duration =
| |
| | condition save =
| |
| | condition dc =
| |
| | condition2 =
| |
| | condition2 duration =
| |
| | condition2 save =
| |
| | condition2 dc =
| |
| | where to find =
| |
| }} | |
| </pre>
| |
| | |
| Example follows.
| |
| | |
| = Cool Armour = | |
| | |
| {{EquipmentPage | |
| <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:EquipmentPage -->
| |
| | name = Cool Armour | |
| | image = Leather Armour PlusOne Icon.png | |
| | description = '''Cool Armour''' is an uncommon [[Armour#Light Armour|Light Armour]] that increases [[Strength]] [[Saving Throw]]s and allows the wearer to cast a neat spell. | |
| | quote = The in-game flavor text in the item's tooltip.
| |
| | type = Light Armour | |
| | proficiency = Light Armour | |
| | armour class = 12 | |
| | armour class bonus = | |
| | stealth disadvantage = yes
| |
| | enchantment =
| |
| | rarity = uncommon
| |
| | weight kg = 4.5
| |
| | weight lb = 9.9
| |
| | price = 600
| |
| | uid = MAG_Cool_LeatherArmour_1
| |
| | uuid = 13776348-0101-446e-a9f8-c95efb3763ca
| |
| | special =
| |
| * '''[[Strength]] [[Saving Throw]]s:''' +1
| |
| * '''Super Cool Ability:''' Once per [[Long Rest]] you can use this awesome ability of this item.
| |
| | where to find =
| |
| This is a made-up piece of equipment. You cannot obtain it anywhere in the game.
| |
| | this is an example = yes
| |
| }} | | }} |
| | | }}</includeonly><noinclude>{{documentation}} |
| = Cool Shield =
| |
| | |
| {{EquipmentPage
| |
| <!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:EquipmentPage --> | |
| | name = Cool Shield
| |
| | image = The Real Sparky Sparkswall Icon.png
| |
| | icon = The Real Sparky Sparkswall Unfaded Icon.png
| |
| | description = {{uncommon|Cool shield}} is an uncommon [[Shield]] that allows the wearer to cast a ton of spells. <!-- This is the first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy. -->
| |
| | quote = The in-game flavor text in the item's tooltip.
| |
| | type = Shields
| |
| | proficiency = Shields
| |
| | armour class =
| |
| | armour class bonus = +3
| |
| | stealth disadvantage =
| |
| | enchantment =
| |
| | rarity = uncommon
| |
| | weight kg = 4.5
| |
| | weight lb = 9.9
| |
| | price = 600
| |
| | special =
| |
| * '''[[Strength]] [[Saving Throw]]s:''' +1
| |
| * '''Super Cool Ability:''' Once per [[Long Rest]] you can use this awesome ability of this item.
| |
| | where to find =
| |
| This is a made-up piece of equipment. You cannot obtain it anywhere in the game.
| |
| | this is an example = yes
| |
| | condition = Wet
| |
| | condition duration = 2
| |
| | condition2 = Prone
| |
| | condition2 duration = Long Rest
| |
| }} | |
| | |
| ----
| |
| | |
| [[Category:Page generating templates]] [[Category:Equipment page templates]]
| |
| | |
| {{#cargo_declare: _table = equipment | | {{#cargo_declare: _table = equipment |
| | name = String (unique; mandatory) | | | name = String (unique; mandatory) |
Line 283: |
Line 127: |
| | special = Wikitext | | | special = Wikitext |
| | legacy = String(allowed values = inaccessible, unobtainable) | | | legacy = String(allowed values = inaccessible, unobtainable) |
| }} | | }}</noinclude> |
| </noinclude><includeonly>{{#switch: {{{this is an example|}}}
| |
| | yes =
| |
| | #default = {{#cargo_store: _table = equipment
| |
| | name = {{{name | {{#titleparts: {{PAGENAME}} }} }}}
| |
| | legacy = {{#var:legacy}} <!-- Intentionally using a page-scope var to pick up information from a different template. -->
| |
| | proficiency = {{{proficiency|}}}
| |
| | stealth_disadvantage = {{IfEmpty | {{{stealth disadvantage|}}} | no}}
| |
| | rarity = {{IfEmpty | {{{rarity|}}} | common}}
| |
| | rarity_order = {{#switch: {{{rarity|}}}
| |
| | | common = 0
| |
| | uncommon = 1
| |
| | rare = 2
| |
| | very rare = 3
| |
| | legendary = 4
| |
| | story = 5
| |
| }}
| |
| }}
| |
| }}</includeonly><noinclude>
| |
| TemplateData documentation follows from this point on.
| |
| | |
| ----
| |
| <templatedata>
| |
| {
| |
| "params": {
| |
| "name": {
| |
| "description": "Name of the item; can be left empty to automatically use the page name.",
| |
| "example": "Amulet of Misty Step",
| |
| "type": "string",
| |
| "suggested": true
| |
| },
| |
| "image": {
| |
| "description": "The filename of the image/icon associated with this item.",
| |
| "example": "Amulet of Misty Step Icon.png",
| |
| "type": "wiki-file-name",
| |
| "suggested": true
| |
| },
| |
| "description": {
| |
| "description": "The first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy.",
| |
| "example": "{{uncommon|Amulet of Misty Step}} is an uncommon [[Amulets|Amulet]] that allows the wearer to cast [[Misty Step]].",
| |
| "type": "content",
| |
| "required": true,
| |
| "suggested": true
| |
| },
| |
| "quote": {
| |
| "description": "The in-game flavour text in the item's tooltip.",
| |
| "type": "content",
| |
| "suggested": true
| |
| },
| |
| "where to find": {
| |
| "description": "Describe where and how to obtain the item.",
| |
| "example": "Looted from [[NPC Name]] in [[Location]].",
| |
| "type": "content",
| |
| "suggested": true
| |
| },
| |
| "type": {
| |
| "description": "Equipment type. Choose one of: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Boots, Cloaks, Gloves, Helmets, Rings, Camp Clothes, Camp Shoes, Undergarments",
| |
| "type": "string",
| |
| "required": true,
| |
| "suggested": true,
| |
| "suggestedvalues": [
| |
| "Clothing",
| |
| "Light Armour",
| |
| "Medium Armour",
| |
| "Heavy Armour",
| |
| "Shields",
| |
| "Amulets",
| |
| "Boots",
| |
| "Cloaks",
| |
| "Gloves",
| |
| "Helmets",
| |
| "Rings",
| |
| "Camp Clothes",
| |
| "Camp Shoes",
| |
| "Undergarments"
| |
| ]
| |
| },
| |
| "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
| |
| },
| |
| "armour class": {
| |
| "description": "Leave EMPTY for non-Armour/non-Clothing, otherwise: the Armour Class value displayed on the Armour's tooltip.",
| |
| "example": "12",
| |
| "type": "number",
| |
| "suggested": true
| |
| },
| |
| "armour class bonus": {
| |
| "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
| |
| },
| |
| "condition": {
| |
| "description": "The full name of the condition (if any) that this action applies to its target/s. Leave blank if there is no condition.",
| |
| "example": "Hastened",
| |
| "type": "string"
| |
| },
| |
| "condition duration": {
| |
| "description": "The duration in turns of the action's applied condition. Leave blank if the duration is unlimited.",
| |
| "example": "5",
| |
| "type": "number"
| |
| },
| |
| "condition save": {
| |
| "description": "The save that the action's target must roll to avoid or reduce its effects. Can use short or long name, e.g: \"STR\" or \"Strength\"",
| |
| "example": "WIS",
| |
| "type": "string",
| |
| "suggestedvalues": [
| |
| "Strength",
| |
| "Dexterity",
| |
| "Constitution",
| |
| "Intelligence",
| |
| "Wisdom",
| |
| "Charisma"
| |
| ]
| |
| },
| |
| "condition dc": {
| |
| "description": "The optional fixed DC of the condition that targets have to pass to apply it",
| |
| "example": "12",
| |
| "type": "number"
| |
| },
| |
| "condition2": {
| |
| "description": "The full name of the condition (if any) that is applied if there is a second condition.",
| |
| "example": "Hastened",
| |
| "type": "string"
| |
| },
| |
| "condition2 duration": {
| |
| "description": "The duration in turns of the action's second condition. Leave blank if the duration is unlimited.",
| |
| "example": "5",
| |
| "type": "number"
| |
| },
| |
| "condition2 save": {
| |
| "description": "The save that the action's target must roll to avoid or reduce the effects of the second condition. Can use short or long name, e.g: \"STR\" or \"Strength\"",
| |
| "example": "WIS",
| |
| "type": "string",
| |
| "suggestedvalues": [
| |
| "Strength",
| |
| "Dexterity",
| |
| "Constitution",
| |
| "Intelligence",
| |
| "Wisdom",
| |
| "Charisma"
| |
| ]
| |
| },
| |
| "condition2 dc": {
| |
| "description": "The optional fixed DC of the second condition that targets have to pass to apply it",
| |
| "example": "12",
| |
| "type": "number"
| |
| },
| |
| "icon": {
| |
| "description": "The icon for the item. Falls back to \"image\" if not specified."
| |
| },
| |
| "uid": {
| |
| "description": "The uid for the item. In format OBJ_Someitem_Whatever.",
| |
| "type": "string"
| |
| },
| |
| "uuid": {
| |
| "description": "The uuid or Root Template of the item. In format 13776348-0101-446e-a9f8-c95efb3763ca",
| |
| "type": "string"
| |
| }
| |
| },
| |
| "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, Boots, Cloaks, Gloves, Helmets, Rings, Camp Clothes, Camp Shoes, Undergarments. (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",
| |
| "paramOrder": [
| |
| "name",
| |
| "image",
| |
| "icon",
| |
| "description",
| |
| "quote",
| |
| "where to find",
| |
| "type",
| |
| "proficiency",
| |
| "armour class",
| |
| "armour class bonus",
| |
| "stealth disadvantage",
| |
| "rarity",
| |
| "enchantment",
| |
| "weight kg",
| |
| "weight lb",
| |
| "price",
| |
| "uid",
| |
| "uuid",
| |
| "special",
| |
| "condition",
| |
| "condition duration",
| |
| "condition save",
| |
| "condition dc",
| |
| "condition2",
| |
| "condition2 duration",
| |
| "condition2 save",
| |
| "condition2 dc"
| |
| ]
| |
| }
| |
| </templatedata></noinclude>
| |