Difference between revisions of "Template:Attribute/doc"

From Project: Gorgon Wiki
Jump to: navigation, search
(Adding documentation. Now to fix bugs.)
 
m
 
(2 intermediate revisions by the same user not shown)
Line 5: Line 5:
  
 
== Syntax ==
 
== Syntax ==
:Type <nowiki>{{Attribute|name}}</nowiki> where you want the Attribute icon and label to display.
+
:Type <nowiki>{{Attribute|name|bonus}}</nowiki> where you want the Attribute icon, label, and modifier to display.
  
 
== Parameters ==
 
== Parameters ==
 
; name
 
; name
 
: The name of the Attribute as listed in the Attributes json.
 
: The name of the Attribute as listed in the Attributes json.
 
+
: bonus
 +
: The modifier found on the item.
 +
: <nowiki>"{MAX_ARMOR}{15}",</nowiki> (From Basic Boots in items json) = <nowiki>{{Attribute|MAX_ARMOR|+15}}</nowiki>
 
== Sample output ==
 
== Sample output ==
 
;Basic usage
 
;Basic usage
Line 18: Line 20:
 
| Output
 
| Output
 
|-
 
|-
| {{tlc|Attribute|BOOST_ABILITY_SURGECUT}}
+
| <nowiki>{{Attribute|BOOST_ABILITY_SURGECUT|+5}}</nowiki>
 
| &rArr;
 
| &rArr;
| {{Attribute|BOOST_ABILITY_SURGECUT}}
+
| {{Attribute|BOOST_ABILITY_SURGECUT|+5}}
 +
|}
 +
:{| class="wikitable"
 +
| Code
 +
| {{=}}
 +
| Output
 +
|-
 +
| <nowiki>{{Attribute|MAX_ARMOR|+15}}</nowiki>
 +
| &rArr;
 +
| {{Attribute|MAX_ARMOR|+15}}
 
|}
 
|}
 
== Notes ==
 
== Notes ==
 
+
Do not place a * or : before the Attributes template. If you need to display a list of attribute, use a <nowiki><br></nowiki> tag after the first call of the template.
 
<includeonly>
 
<includeonly>
 
<!-- Categories/interwikis for the template itself -->
 
<!-- Categories/interwikis for the template itself -->

Latest revision as of 18:11, 17 June 2021

Description

Use this template whenever you want to display an Attribute from the Attributes JSON file (Treasure effect on an item)
If you only want to display an Attribute icon, or use a larger image of the icon, use the Attribute icon template.
If you only want to display an Attribute Label (what the attribute looks like in-game), use the Attribute label template.

Syntax

Type {{Attribute|name|bonus}} where you want the Attribute icon, label, and modifier to display.

Parameters

name
The name of the Attribute as listed in the Attributes json.
bonus
The modifier found on the item.
"{MAX_ARMOR}{15}", (From Basic Boots in items json) = {{Attribute|MAX_ARMOR|+15}}

Sample output

Basic usage
Code = Output
{{Attribute|BOOST_ABILITY_SURGECUT|+5}}
icon_3601.png Surge Cut Damage
 
+5
Code = Output
{{Attribute|MAX_ARMOR|+15}}
icon_101.png Max Armor
 
+15

Notes

Do not place a * or : before the Attributes template. If you need to display a list of attribute, use a <br> tag after the first call of the template.