Template:Equipment/Recommended/doc: Difference between revisions

From Melvor Idle
No edit summary
(Update docs)
Line 3: Line 3:
==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.
For the <code>style</code> parameter, pass the relevant combat style: Melee, Ranged, or Magic.
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.


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 20: Line 24:
|ring# =
|ring# =
|passive# =
|passive# =
|familiar1#
|familiar1# =
|familiar2#
|familiar2# =
}}</pre>
}}</pre>

Revision as of 17:54, 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.

For the style parameter, pass the relevant combat style: Melee, Ranged, or Magic.

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# =
}}