Difference between revisions of "Template:Ability"

Revision as of 06:21, 2 April 2022

This template is used on equipment for the ability enchantment. It shows the text of the ability as close as possible to the way it looks on an items examine window.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Ability	`1`	This specifies which Ability is being added. Example {{Ability\|Constitution\|10}}	String	required
Enhancement Amount	`2`	This is the amount the ability is increased or decreased. A negative value here will produce "penalty" instead of "bonus". Example {{Ability\|Constitution\|10}}	Number	required
Bonus Type	`3`	This is the type of bonus - Insight, Enhancement, Quality, etc. Default Enhancement Example {{Ability\|Constitution\|10\|Insight}}	String	suggested
Title	`4`	A specific title to this enchantment Example {{Ability\|Dexterity\|-1\|\|Curse of Clumsiness}}	String	optional

@@ Line 1: / Line 1: @@
-<noinclude>{{TemplateDocumentation
+<noinclude>
-|name = Ability
+<templatedata>
-|description = This template is used on equipment for the ability enchantment.  It shows the text of the ability as close as possible to the way it looks on an items examine window.
+{
-|category=Item Enchantment Template
+ "params": {
-|usesnamedparameters=
+ "1": {
-|example1 = <nowiki>{{Ability|Constitution|10|Insight}}</nowiki>
+ "label": "Ability",
-|example1output = {{Ability|Constitution|10|Insight}}
+ "description": "This specifies which Ability is being added.",
-|example2 = <nowiki>{{Ability|Dexterity|-1||Curse of Clumsiness}}</nowiki>
+ "type": "string",
-|example2output = {{Ability|Dexterity|-1||Curse of Clumsiness}}
+ "required": true,
-|parameter1name = Ability
+ "example": "{{Ability|Constitution|10}}"
-|parameter1description = This specifies which [[Abilities|Ability]] is being added.
+ },
-|parameter1values =
+ "2": {
-|parameter2name = Enhancement Amount
+ "label": "Enhancement Amount",
-|parameter2description = This is the amount the ability is increased or decreased.  A negative value here will produce "penalty" instead of "bonus".
+ "description": "This is the amount the ability is increased or decreased. A negative value here will produce \"penalty\" instead of \"bonus\".",
-|parameter2values =
+ "type": "number",
-|parameter3name = Bonus Type
+ "required": true,
-|parameter3description = This is the type of bonus - Insight, Enhancement, Quality, etc.  If you don't specify a value here it will default to Enhancement.
+ "example": "{{Ability|Constitution|10}}"
-|parameter3values =
+ },
-|parameter4name = Title
+ "3": {
-|parameter4description = A specific title to this enchantment
+ "label": "Bonus Type",
-}}<!-- If updating this template is required, don't forget to update the categorization! -->
+ "description": "This is the type of bonus - Insight, Enhancement, Quality, etc.",
-</noinclude><onlyinclude>{{EnchTitle|Abilities#{{{1}}}|{{#ifexpr: {{{2}}} < 0 ||{{BonusTypeNameConversion|{{{3|}}}|True}}}} {{{1}}} {{#ifexpr: {{{2}}} < 0 ||+}}{{{2}}}|{{{4|}}}}}{{EnchBody|Passive: {{#ifexpr: {{{2}}} < 0 ||+}}{{{2}}} {{#ifexpr: {{{2}}} < 0 ||{{BonusTypeNameConversion|{{{3|Enhancement}}}}}}} {{#ifexpr: {{{2}}} < 0 |penalty|bonus}} to {{#switch: {{{1|}}}
+ "type": "string",
+ "default": "Enhancement",
+ "suggested": true,
+ "example": "{{Ability|Constitution|10|Insight}}"
+ },
+ "4": {
+ "label": "Title",
+ "description": "\tA specific title to this enchantment",
+ "type": "string",
+ "example": "{{Ability|Dexterity|-1||Curse of Clumsiness}}"
+ }
+ },
+ "description": "This template is used on equipment for the ability enchantment. It shows the text of the ability as close as possible to the way it looks on an items examine window.",
+ "format": "inline"
+}
+</templatedata>[[Category:Template]]
+</noinclude><includeonly>{{EnchTitle|Abilities#{{{1}}}|{{#ifexpr: {{{2}}} < 0 ||{{BonusTypeNameConversion|{{{3|}}}|True}}}} {{{1}}} {{#ifexpr: {{{2}}} < 0 ||+}}{{{2}}}|{{{4|}}}}}{{EnchBody|Passive: {{#ifexpr: {{{2}}} < 0 ||+}}{{{2}}} {{#ifexpr: {{{2}}} < 0 ||{{BonusTypeNameConversion|{{{3|Enhancement}}}}}}} {{#ifexpr: {{{2}}} < 0 |penalty|bonus}} to {{#switch: {{{1|}}}
 |Well Rounded=All Abilities.
 |#default={{{1}}}.
@@ Line 26: / Line 42: @@
 |Well Rounded=All Abilities
 |#default={{ucfirst:{{lc:{{{1|}}}}}}}
-}}}}</onlyinclude>
+}}}}</includeonly>