Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Template:Equipment page: Difference between revisions

Template page
mNo edit summary
No edit summary
 
(100 intermediate revisions by 12 users not shown)
Line 1: Line 1:
<includeonly>{{PageSeo
<includeonly>{{#lvardef: filename | {{#replace:{{#replace:{{#replace:{{#replace:{{#titleparts: {{PAGENAME}} }}|:|}}|/|<nowiki/> <nowiki/>}}|(|<nowiki/> <nowiki/>}}|)|<nowiki/> <nowiki/>}}}}{{#lvardef: icon | {{#if: {{{icon|}}} | {{{icon}}} | {{#lvar: filename}} Unfaded Icon.png }} }}{{#lvardef: controllericon | {{#if: {{{controller icon|}}} | {{{controller icon}}} | {{#lvar: filename}} Unfaded.png }} }}{{#switch: {{{this is an example|}}}
| image = {{{image}}}
| yes =
| description = {{EquipmentPage/Description
| #default = {{PageSeo
  | type = {{{type}}}
  | image = {{#lvar: controllericon}}
  | rarity = {{{rarity|}}}
  | description = {{#if: {{{description|}}} | {{{description}}} | {{EquipmentPage/Description
    | type = {{{type}}}
    | rarity = {{{rarity|}}}
    }} }}
   }}
   }}
}} __NOTOC__
}} __NOTOC__
Line 11: Line 14:
}}">
}}">


{{#if:{{{image|}}} | [[File:{{{image}}}|frameless|right]] | [[Category:Equipment pages without images]]}}
{{#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. -->


{{quote|{{{quote|Missing quote ... imagine some nice flavor text here.}}}}}
{{#if: {{{quote|}}} | {{Description|{{{quote}}}}} }}


== Properties ==
<h2> Properties </h2>
 
{{#if: {{{armour class|}}} |
* {{#switch: {{{type|}}}
{{Armour class value|{{{armour class}}}|{{#switch: {{{type|}}}
| Light Armour = {{LightArmour}}
| Clothing = [[Armour Class]] + [[Dexterity#Dexterity Modifier Chart|Dexterity modifier]]
| Medium Armour = {{MediumArmour}}
| Light Armour = [[Armour Class]] + [[Dexterity#Dexterity Modifier Chart|Dexterity modifier]]
| Heavy Armour = {{HeavyArmour}}
| Medium Armour = {{#ifeq: {{{dex override}}}  
| Shields = {{Shields}}
    | yes | [[Armour Class]] + [[Dexterity#Dexterity Modifier Chart|Dexterity modifier]]
| #default = [[{{{type}}}]] }}
    | [[Armour Class]] + [[Dexterity#Dexterity Modifier Chart|Dexterity modifier]] ''(max +2)''}}
** Required Proficiency: {{#switch: {{{proficiency|}}}
| Heavy Armour = [[Armour Class]]
| Light Armour = {{LightArmour}}
| #default = [[Armour Class]]}}}}
| Medium Armour = {{MediumArmour}}
}} {{#if: {{{armour class bonus|}}} |
| Heavy Armour = {{HeavyArmour}}
{{Armour class value|{{{armour class bonus}}}|[[Armour Class]]}}
| Shields = {{Shields}}
}}
| #default = None}} {{#if: {{{armour class|}}} |
<div class="bg3wiki-property-list" style="margin-left: 7px">
** {{ArmourClass}}: {{#switch: {{{type|}}}
{{#if: {{{type|}}} |
| Clothing = {{{armour class}}} ''(Clothing grants no inherent AC bonus)''
* {{WeaponType | {{{type}}} }}
| Light Armour = {{{armour class}}} + [[Dexterity#Dexterity_Modifier_Chart|Dexterity Modifier]]
}} {{#if: {{{proficiency|}}} |
| Medium Armour = {{{armour class}}} + [[Dexterity#Dexterity_Modifier_Chart|Dexterity Modifier]] ''(AC bonus from Dexterity limited to +2)''
* {{Icon|Proficiency Icon.png|32}} Required Proficiency: {{WeaponType|{{{proficiency}}}}}
| Heavy Armour = {{{armour class}}}
}} {{#if: 1 |
| #default = }} }} {{#if: {{{armour class bonus|}}} |
* {{Rarity | {{{rarity|common}}} | {{{rarity honour|}}} }}
** {{ArmourClass}}: {{{armour class bonus}}} }} {{#if: {{{stealth disadvantage|}}} |
}} {{#if: {{{enchantment|}}} |
** {{Disadvantage}} on [[Stealth]] checks }}
* {{Enchantment | {{{enchantment|}}} }}
* {{Rarity | {{{rarity|common}}} }} {{#if: {{{enchantment|}}} |  
}} {{#if: {{{weight kg|}}} |
* {{Enchantment | {{{enchantment|}}} }} }}
* {{Weight | kg = {{{weight kg}}} | lb = {{{weight lb}}} }}
* {{Weight | kg = {{{weight kg}}} | lb = {{{weight lb}}} }}
* {{Price | {{{price}}} }} {{#if: {{{special|}}} | {{blank}}
}} {{#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 ===
=== Special ===


The wearer of this item gains:
The wearer of this item gains:
{{#if: {{{special|}}} | {{blank}}
{{{special}}}
{{{special}}}
}}</div> {{#if: {{{where to find|}}} | {{blank}}


== Where to Find ==
}}{{#if: {{{passives|}}} | {{blank}}
{{#invoke: ParseList | main | {{{passives}}} | useTemplate = Passive | type = none }}
 
}}{{#if: {{{stealth disadvantage|}}} | {{blank}}
 
* {{Disadvantage}} on [[Stealth]] checks. }}


<div class="bg3wiki-tooltip-box">
{{{where to find}}}
</div>
}}
}}
{{clear}}</div> {{#if: {{{grants|}}} |


{{#switch: {{{this is an example|}}} <!-- Don't put categories on example pages. -->
<h2> Grants: </h2>
| yes =
| #default = [[Category:{{{type}}}]] {{#ifeq: {{{rarity|}}} | very rare | [[Category:Very Rare Items]] | [[Category:{{{rarity|common}}} Items]]}}
}}</includeonly><noinclude><!--


    ==== Documentation follows ====
<div class="bg3wiki-tooltip-box bg3wiki-tooltip-gradient-common">
{{#invoke: ParseList | main | {{{grants}}} | type = htmlListNoBullets | useTemplate = SAI/fixed }}
</div>


-->
}} {{#if: {{{condition|}}} | {{blank}}
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]].


'''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).'''
<h2> Condition: {{{condition}}} </h2>


<pre>
<div class="bg3wiki-tooltip-box bg3wiki-tooltip-gradient-common">
{{EquipmentPage
{{Condition | {{{condition}}}
<!-- See here for tips on how to use this template: https://bg3.wiki/wiki/Template:EquipmentPage -->
| save = {{{condition save|}}}
| image =
| duration = {{{condition duration|}}}
| description =  
| dc = {{{condition dc|}}}
| quote = The in-game flavor text in the item's tooltip.
| type =  
| proficiency =
| armour class =  
| armour class bonus =
| stealth disadvantage =
| enchantment =
| rarity =
| weight kg =
| weight lb =
| price =
| special = <!-- List of special features, bonuses, or abilities granted by the item. -->
| where to find =
| this is an example = yes
}}
}}
</pre>
{{main namespace only|{{Inflicts|{{{condition}}}|item|type=equipment|save={{{condition save|}}}|dc={{{condition dc|}}}|duration={{{condition duration|}}}}}}}
</div>
}} {{#if: {{{condition2|}}} | {{blank}}


Example follows.
<h2> Condition: {{{condition2}}} </h2>
 
<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|type=equipment|save={{{condition2 save|}}}|dc={{{condition2 dc|}}}|duration={{{condition2 duration|}}}}}}}
</div>
}} {{#if: {{{where to find|}}}{{{where to find2|}}}{{{where to find3|}}}{{{where to find4|}}}{{{where to find5|}}} | {{blank}}


= Cool Armour =
<h2> Where to find </h2>


{{EquipmentPage
<div class="bg3wiki-tooltip-box">
| name = Cool Armour
{{#if: {{{where to find|}}}|
| image = Leather Armour PlusOne Icon.png
{{Where to find|{{{where to find}}}|{{{where to find location|}}}|{{{where to find x|}}}|{{{where to find y|}}}}}
| 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. <!-- This is the first text that will appear on the page. Briefly describe what the item is and what makes it noteworthy. -->
}}{{#if: {{{where to find2|}}}|  
| quote = The in-game flavor text in the item's tooltip.
{{Where to find|{{{where to find2}}}|{{{where to find2 location|}}}|{{{where to find2 x|}}}|{{{where to find2 y|}}}}}
| type = Light Armour <!-- Item type. Choose one of: Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Belts, Boots, Cloaks, Gloves, Helmets, Rings -->
}}{{#if: {{{where to find3|}}}|
| proficiency = Light Armour <!-- Leave EMPTY if no proficiency needed, otherwise choose from: Light Armour, Medium Armour, Heavy Armour, Shields -->
{{Where to find|{{{where to find3}}}|{{{where to find3 location|}}}|{{{where to find3 x|}}}|{{{where to find3 y|}}}}}
| <!-- Following are Armour- and Shield-related properties -->
}}{{#if: {{{where to find4|}}}|  
| armour class = 12 <!-- Leave EMPTY for non-Armour, otherwise: the Armour Class value displayed on the armour's tooltip. -->
{{Where to find|{{{where to find4}}}|{{{where to find4 location|}}}|{{{where to find4 x|}}}|{{{where to find4 y|}}}}}
| armour class bonus = <!-- Leave EMPTY for non-Shields, otherwise: the bonus to AC granted by wearing this item, e.g.: +2, +3, +4 -->
}}{{#if: {{{where to find5|}}}|
| stealth disadvantage = <!-- Does this item grant disadvantage on stealth checks? LEAVE EMPTY if no! -->
{{Where to find|{{{where to find5}}}|{{{where to find5 location|}}}|{{{where to find5 x|}}}|{{{where to find5 y|}}}}}
| enchantment = <!-- Leave EMPTY for none, otherwise: +1, +2, +3, +4, +5 -->
| <!-- Following are general properties, which should be filled in for ALL types of equipment. -->
| rarity = uncommon <!-- Choose from: common, uncommon, rare, very rare, legendary, story -->
| weight kg = 4.5
| weight lb = 9.9
| price = 600
| special = <!-- List of special features, bonuses, or abilities granted by the item. -->
* '''[[Strength]] [[Saving Throw]]s:''' +1
* '''Super Cool Ability:''' Once per [[Long Rest]] you can use this awesome ability of this item.
| where to find = <!-- Describe where and how to obtain the item. -->
This is a made-up piece of equipment.  You cannot obtain it anywhere in the game.
| this is an example = yes
}}
}}
</div> }} {{#if: {{{notes|}}} | {{blank}}
<h2> Notes </h2>


----
<div class="bg3wiki-tooltip-box">
{{{notes}}}
</div>
}} {{#if: {{{bugs|}}} | {{blank}}


[[Category:Page Generating Templates]] [[Category:Equipment Page Templates]]
<h2> Bugs </h2>


<div class="bg3wiki-tooltip-box">
{{{bugs}}}
{{Main namespace only|[[Category:Bugs]]}}
</div>
}} {{Main namespace only|[[Category:{{{type}}}]]{{#switch: {{lc:{{{rarity|}}}}}
| common = [[Category:Common items]]
| uncommon = [[Category:Uncommon items]]
| rare = [[Category:Rare items]]
| very rare = [[Category:Very rare items]]
| legendary = [[Category:Legendary items]]
| story = [[Category:Story items]]
| #default = [[Category:Common items]]}}{{ItemIcon Insert
|icon={{{icon|}}}
|uid={{{uid|}}}
|image={{{controller icon|}}}
|rarity={{{rarity|common}}}
}}{{#cargo_store: _table = equipment
| name = {{{name | {{#titleparts: {{PAGENAME}} }} }}}
| image = {{{image|}}}
| controller_icon = {{#lvar:controllericon}}
| icon = {{#lvar:icon}}
| uid = {{{uid|}}}
| 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>{{documentation}}
{{#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
| where_to_find = Wikitext
| where_to_find = Wikitext
| type = Page
| type = String
| proficiency = String (allowed values = Light Armour, Medium Armour, Heavy Armour, Shields)
| proficiency = String (allowed values = Light Armour, Medium Armour, Heavy Armour, Shields)
| armour_class = String
| armour_class = String
Line 138: Line 177:
| rarity_order = Integer
| rarity_order = Integer
| enchantment = String
| enchantment = String
| weight_kg = Float
| weight_kg = String
| weight_lb = Float
| weight_lb = String
| price = Integer
| price = String
| passives = List (,) of String
| special = Wikitext
| special = Wikitext
| legacy = String(allowed values = inaccessible, unobtainable)
| bugs = Wikitext
}}
}}
</noinclude><includeonly>{{#switch: {{{this is an example|}}}
[[Category:Templates]]
| yes =
[[Category:Equipment page templates]]
| #default = {{#cargo_store: _table = equipment
[[Category:Page generating templates]]
| name = {{{name | {{#titleparts: {{PAGENAME}} }} }}}
[[Category:Cargo templates]]
| stealth_disadvantage = {{IfEmpty | {{{stealth disadvantage|}}} | no}}
</noinclude>
| 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
}
},
"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"
}
</templatedata></noinclude>