Template:Equipment/Recommended/doc: Difference between revisions
From Melvor Idle
No edit summary |
mNo edit summary |
||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
This template displays the recommended equipment for an activity. | This template displays the recommended equipment for an activity. | ||
==Usage== | ==Usage== | ||
This template can be used by entering the following onto a relevant page. | This template can be used by entering the following onto a relevant page. | ||
The following parameters are supported: | |||
* <code>style</code> - Optional. Specifies the relevant combat style: Melee, Ranged, or Magic. | |||
* <code>imgSize</code> - Optional. Specifies the slot image's dimensions in pixels. Defaults to 36 if not specified. | |||
* <code>showDR</code> - Optional. If <code>true</code>, adds another column listing the equipments' damage reduction statistic. Only supported if at most one item of equipment is specified for each equipment slot | |||
* <code>showall</code> - Optional. If <code>true</code>, shows all item slots in the table even if the slot is empty | |||
* <code>setname</code> - Optional. Specifies the custom text above the table's header; 'Recommended equipment for <setname>' | |||
* <code>header#</code> - Optional. Specifies the custom header text for headers 1 through 5 | |||
For all other parameters, the value passed will be the name of an item of equipment by default. If required, plain text may also be passed by prefixing the value with <code>!</code>. For example, specifying <code>passive1 = !Any Master Slayer armour piece</code> will result in the text following the prefix to be displayed in the table as is. A slot can also be left empty by passing in <code>Empty</code> as the item name. | |||
Currently there is a cap of 5 that will be rendered per slot. Anything added past that will not be shown on the table. | Currently there is a cap of 5 that will be rendered per slot. Anything added past that will not be shown on the table. | ||
| Line 10: | Line 18: | ||
<pre>{{Equipment/Recommended | <pre>{{Equipment/Recommended | ||
|style = | |style = | ||
|imgSize = | |||
|showDR = true|false | |||
|showall = true|false | |||
|setname = | |||
|header# = | |||
|helm# = | |helm# = | ||
|neck# = | |neck# = | ||
| Line 16: | Line 29: | ||
|legs# = | |legs# = | ||
|weapon# = | |weapon# = | ||
|shield# = | |shield# = | ||
|ammo# = | |ammo# = | ||
|consumable# = | |||
|gloves# = | |gloves# = | ||
|boots# = | |boots# = | ||
|ring# = | |ring# = | ||
| | |gem# = | ||
|passive# = | |||
|familiar1# = | |||
|familiar2# = | |||
|enhC# = | |||
|enhT# = | |||
|enhS# = | |||
|prayer1# = | |||
|prayer2# = | |||
}}</pre> | }}</pre> | ||
Latest revision as of 20:12, 12 October 2024
This template displays the recommended equipment for an activity.
Usage
This template can be used by entering the following onto a relevant page.
The following parameters are supported:
style- Optional. Specifies the relevant combat style: Melee, Ranged, or Magic.imgSize- Optional. Specifies the slot image's dimensions in pixels. Defaults to 36 if not specified.showDR- Optional. Iftrue, adds another column listing the equipments' damage reduction statistic. Only supported if at most one item of equipment is specified for each equipment slotshowall- Optional. Iftrue, shows all item slots in the table even if the slot is emptysetname- Optional. Specifies the custom text above the table's header; 'Recommended equipment for <setname>'header#- Optional. Specifies the custom header text for headers 1 through 5
For all other parameters, the value passed will be the name of an item of equipment by default. If required, plain text may also be passed by prefixing the value with !. For example, specifying passive1 = !Any Master Slayer armour piece will result in the text following the prefix to be displayed in the table as is. A slot can also be left empty by passing in Empty as the item name.
Currently there is a cap of 5 that will be rendered per slot. Anything added past that will not be shown on the table.
{{Equipment/Recommended
|style =
|imgSize =
|showDR = true|false
|showall = true|false
|setname =
|header# =
|helm# =
|neck# =
|cape# =
|body# =
|legs# =
|weapon# =
|shield# =
|ammo# =
|consumable# =
|gloves# =
|boots# =
|ring# =
|gem# =
|passive# =
|familiar1# =
|familiar2# =
|enhC# =
|enhT# =
|enhS# =
|prayer1# =
|prayer2# =
}}