Template:Equipment/Recommended/doc: Difference between revisions
From Melvor Idle
(Update docs) |
(Update docs for imgSize/showDR parameters) |
||
| Line 4: | Line 4: | ||
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. Adds another column listing the equipments' damage reduction statistic. Only supported if at most one item of equipment is specified for each equipment slot | |||
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. | 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. | ||
Revision as of 22:32, 3 June 2022
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. Adds another column listing the equipments' damage reduction statistic. Only supported if at most one item of equipment is specified for each equipment slot
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.
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 =
|helm# =
|neck# =
|cape# =
|body# =
|legs# =
|weapon# =
|shield# =
|ammo# =
|gloves# =
|boots# =
|ring# =
|passive# =
|familiar1# =
|familiar2# =
}}