Template:Equipment page: Difference between revisions

Jump to navigation Jump to search

Template:Equipment page (view source)

Revision as of 21:28, 26 April 2024

8,591 bytes removed ,  26 April
Add 'bugs' parameter.
(category casing)
(Add 'bugs' parameter.)
(34 intermediate revisions by 8 users not shown)
Line 2: Line 2:
| yes =
| yes =
| #default = {{PageSeo
| #default = {{PageSeo
   | image = {{{image}}}
   | image = {{#if:{{{controller icon|}}}|{{{controller icon}}}|{{#if:{{{image|}}}|{{{image}}}|{{{icon|}}}}}}}
   | description = {{{seo description|{{EquipmentPage/Description
   | description = {{{description|{{EquipmentPage/Description
     | type = {{{type}}}
     | type = {{{type}}}
     | rarity = {{{rarity|}}}
     | rarity = {{{rarity|}}}
Line 14: Line 14:
}}">
}}">


{{#if: {{{image|}}} | [[File:{{{image}}}|frameless|right||alt={{PAGENAME}} image]] | {{Main only|[[Category:Equipment pages without images]]}}}}{{#if:{{{icon|}}} ||{{Main only|[[Category:Item pages without icons]]}} }}
{{#if: {{{image|}}} | [[File:{{{image}}}|frameless|right|alt={{PAGENAME}} image]] | {{#if:{{{controller icon|}}} | [[File:{{{controller icon}}}|frameless|right|alt={{PAGENAME}} controller icon]] | {{#if:{{{icon|}}} | [[File:{{{icon}}}|frameless|right|alt={{PAGENAME}} icon]] | }} }} }}{{#if: {{{image|}}} || {{Main only|[[Category:Misc pages without images]]}} }}{{#if: {{{controller icon|}}} || {{Main only|[[Category:Item pages without controller icons]]}} }}{{#if: {{{icon|}}} || {{Main only|[[Category:Item pages without icons]]}} }}


{{{description}}} <!-- No support for auto-generated equipment descriptions for now. -->
{{{description}}} <!-- No support for auto-generated equipment descriptions for now. -->
Line 29: Line 29:
     | [[Armour Class]] + [[Dexterity#Dexterity Modifier Chart|Dexterity modifier]] ''(max +2)''}}
     | [[Armour Class]] + [[Dexterity#Dexterity Modifier Chart|Dexterity modifier]] ''(max +2)''}}
| Heavy Armour =  [[Armour Class]]
| Heavy Armour =  [[Armour Class]]
| #default = [[Armour Class]]}}}}}} {{#if: {{{armour class bonus|}}} |
| #default = [[Armour Class]]}}}}
{{Armour class value|{{{armour class bonus}}}|[[Armour Class]]}}}}
}} {{#if: {{{armour class bonus|}}} |
<ul class="bg3wiki-property-list" style="margin-left: 7px">  
{{Armour class value|{{{armour class bonus}}}|[[Armour Class]]}}
{{#if: {{{type|}}} | <li> {{WeaponType | {{{type}}} }} </li>}}
}}
{{#if: {{{proficiency|}}} | <li> {{Icon|Proficiency Icon.png|32}} Required Proficiency: {{WeaponType|{{{proficiency}}}}} </li>}}
<div class="bg3wiki-property-list" style="margin-left: 7px">  
<li> {{Rarity | {{{rarity|common}}} }} </li>
{{#if: {{{type|}}} |
{{#if: {{{enchantment|}}} | <li> {{Enchantment | {{{enchantment|}}} }} </li>}}
* {{WeaponType | {{{type}}} }}
<li> {{Weight | kg = {{{weight kg}}} | lb = {{{weight lb}}} }} </li>
}} {{#if: {{{proficiency|}}} |
<li> {{Price | {{{price}}} }} </li>
* {{Icon|Proficiency Icon.png|32}} Required Proficiency: {{WeaponType|{{{proficiency}}}}}
{{#if:{{{uid|}}}{{{uuid|}}}|<li>{{SmallIcon|Ico stats.png}}{{#if:{{{uid|}}}|{{Uid|{{{uid}}}}} }} {{#if:{{{uuid|}}}|{{Uuid|{{{uuid}}}}} }}</li>}}
}} {{#if: 1 |
</ul> {{#if: {{{special|}}}{{{stealth disadvantage|}}} | {{blank}}
* {{Rarity | {{{rarity|common}}} | {{{rarity honour|}}} }}
}} {{#if: {{{enchantment|}}} |
* {{Enchantment | {{{enchantment|}}} }}
}} {{#if: {{{weight kg|}}} |
* {{Weight | kg = {{{weight kg}}} | lb = {{{weight lb}}} }}
}} {{#if: {{{price|}}} |
* {{Price | {{{price}}} | {{{price honour|}}} }}
}} {{#if: {{{uid|}}} {{{uuid|}}} {{{filename|}}} |
* {{SmallIcon|Ico stats.png}} {{#if: {{{uid|}}} | {{Uid|{{{uid}}}}} }} {{#if: {{{uuid|}}} | {{Uuid|{{{uuid}}}}} }} {{#if: {{{filename|}}}|{{filename|{{{filename}}}}} }}
}}
</div>
{{#if: {{{passives|}}}{{{special|}}}{{{stealth disadvantage|}}} | {{blank}}
=== Special ===
 
The wearer of this item gains: {{#if: {{{passives|}}} | {{blank}}
{{#invoke: ParseList | main | {{{passives}}} | useTemplate = Passive | type = htmlList }}}}{{#if: {{{special|}}} | {{blank}}
{{{special|}}}}}{{#if: {{{stealth disadvantage|}}} | {{blank}}
* {{Disadvantage}} on [[Stealth]] checks. }}
}}{{clear}}</div> {{#if: {{{condition|}}} |
 
<h3> Condition: {{{condition}}} </h3>


<h3> Special </h3>
<div class="bg3wiki-tooltip-box bg3wiki-tooltip-gradient-common">
{{Condition | {{{condition}}}
| save = {{{condition save|}}}
| duration = {{{condition duration|}}}
| dc = {{{condition dc|}}}
}}
{{main namespace only|{{Inflicts|{{{condition}}}|item}}}}
</div>
{{#if: {{{condition2|}}} |
 
<h3> Condition: {{{condition2}}} </h3>
 
<div class="bg3wiki-tooltip-box bg3wiki-tooltip-gradient-common">
{{Condition | {{{condition2}}}
| save = {{{condition2 save|}}}
| duration = {{{condition2 duration|}}}
| dc = {{{condition2 dc|}}}
}}
{{main namespace only|{{Inflicts|{{{condition2}}}|item}}}}
</div>


The wearer of this item gains:
  }}
{{{special}}}
}} {{#if: {{{where to find|}}} |
{{#if: {{{stealth disadvantage|}}} | * {{Disadvantage}} on [[Stealth]] checks. }}
}}{{clear}}</div> {{#if: {{{where to find|}}} | {{blank}}


<h2> Where to find </h2>
<h2> Where to find </h2>
Line 53: Line 90:
{{{where to find}}}
{{{where to find}}}
</div>
</div>
}} {{#if: {{{notes|}}} | {{blank}}
}} {{#if: {{{notes|}}} |


<h2> Notes </h2>
<h2> Notes </h2>
Line 59: Line 96:
<div class="bg3wiki-tooltip-box">
<div class="bg3wiki-tooltip-box">
{{{notes}}}
{{{notes}}}
</div>
}} {{#if: {{{bugs|}}} |
<h2> Bugs </h2>
<div class="bg3wiki-tooltip-box">
{{{bugs}}}
{{Main namespace only|[[Category:Bugs]]}}
</div>
</div>
}}
}}
Line 64: Line 109:
}}{{ItemIcon Insert
}}{{ItemIcon Insert
|icon={{{icon|}}}
|icon={{{icon|}}}
|image={{{image|}}}  
|uid={{{uid|}}}
|image={{{controller icon|}}}
|rarity={{{rarity|common}}}
|rarity={{{rarity|common}}}
}}</includeonly><noinclude><!--
}}{{Main namespace only|{{#cargo_store: _table = equipment
 
| name = {{{name | {{#titleparts: {{PAGENAME}} }} }}}
    ==== Documentation follows ====
| uid = {{{uid|}}}
 
| legacy = {{#var:legacy}} <!-- Intentionally using a page-scope var to pick up information from a different template. -->
-->
| proficiency = {{{proficiency|}}}
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]].
| stealth_disadvantage = {{IfEmpty | {{{stealth disadvantage|}}} | no}}
 
| rarity = {{IfEmpty | {{{rarity|}}} | common}}
'''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_order = {{#switch: {{{rarity|}}}
 
  | | common = 0
<pre>
  | uncommon = 1
{{EquipmentPage
  | rare = 2
 
  | very rare = 3
<!-- High-res image of the item. -->
  | legendary = 4
| image =  
  | 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 =
 
<!-- 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 =
| 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
}}
 
= 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
}}
}}
 
}}</includeonly><noinclude>{{documentation}}
----
 
[[Category:Page generating templates]] [[Category:Equipment page templates]]
 
{{#cargo_declare: _table = equipment
{{#cargo_declare: _table = equipment
| name = String (unique; mandatory)
| name = String
| uid = String
| image = File
| image = File
| controller_icon = File
| icon = File
| description = Wikitext
| description = Wikitext
| quote = Wikitext
| quote = Wikitext
Line 235: Line 149:
| weight_lb = String
| weight_lb = String
| price = String
| price = String
| passives = List (,) of String
| 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
},
"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"
]
}
</templatedata></noinclude>
Retrieved from "https://bg3.wiki/wiki/Special:MobileDiff/116760...178551"

Navigation menu