Template:Resource
- {{r}}
Display action resources, including specific class resources, in a standardised and consistent format. This template is intended to be inline. It can:
- Handle multiple resources at once. The input is a comma separated list of resource names.
- Display in multiple formats suitable for inline usage or for compact table columns.
- Handle auto-categorisation for actions based on resource consumption via the
categories
function. This is not done implicitly so page generators must call this additional function.
This template is a simple wrapper around Module:Resource. Refer there for additional details.
Usage
- Usage
{{Resource | <list of resources> | [icon only] | [force plural] | [show links]}}
< ... >
denotes mandatory parameters and[ ... ]
denotes optional parameters.- The first parameter is a list of resource names (see below) separated by commas. Each resource can have an optional count associated with it separated by a
:
.
- Legacy usage
{{Resource | <type> | [count] | [icononly] | [nameonly] | [forceplural]}}
< ... >
denotes mandatory parameters and[ ... ]
denotes optional parameters.- This old form can only display one resource rather than a list of resources.
Refer to the table below for all the supported resource types and their aliases.
Supported resources
Below is a table of all the resource options this template accepts as well as their aliases.
This should cover all in-game-visible resources. There are additional hidden resources like SneakAttack_Charge
not covered by this template.
Resource | Name and aliases |
---|---|
![]() | action |
![]() | bonus , ba , bonus action |
![]() | reaction |
![]() | movement , movement m , m |
![]() | half movement , 1/2 movement |
![]() | spell1 , s1 , level1 , l1 |
![]() | spell2 , s2 , level2 , l2 |
![]() | spell3 , s3 , level3 , l3 |
![]() | spell4 , s4 , level4 , l4 |
![]() | spell5 , s5 , level5 , l5 |
![]() | spell6 , s6 , level6 , l6 |
![]() | shadowspell3 , shadow spell , ss3 , shadowlevel3 , sl3 |
![]() | wspell , wsp |
![]() | arcarr , aa , arcane arrow |
![]() | arcrec , ar , arcane recovery |
![]() | bi , bardin , bardic inspiration |
![]() | bladesong , bs , bsp , bladesong power |
![]() | cd , chadiv , channel divinity |
![]() | co , oath , chao , chaoat , channel oath |
![]() | cos , cosmic , omen , cosmic omen |
![]() | es , eyestalk , eyestalk action |
![]() | fi , fnginf , fungal infestation |
![]() | ki |
![]() | loh , lh , layonh , lay on hands |
![]() | luck , lp , lukpnt , luck point |
![]() | natrec , nr , natural recovery |
![]() | rage , rg |
![]() | sp , srcpnt , sorcery , sorcery point |
![]() | starmap , sm , star map |
![]() | supdie , sd , superiority die |
![]() | toc , tides , tides of chaos |
![]() | wc , writhing , writhing current |
![]() | ws , wldshp , wildshape , wild shape |
![]() | wp , warpri , war priest |
Examples
Example | Markup | Renders as |
---|---|---|
Basic usage | {{ Resource | action}} | ![]() |
Compact alias | {{r|bonus}} | ![]() |
Optional count specified | {{Resource | ki:3 }} | ![]() |
Multiple resources | {{Resource | action, bonus, spell1}} | ![]() ![]() ![]() |
Movement speed | {{Resource | bonus, m:3 }} | ![]() ![]() |
Icons only | {{Resource | action, bonus, spell1 | icons only = yes}} | ![]() ![]() ![]() |
Show links | {{Resource | action, sp:2 | show links = yes}} | ![]() ![]() |
Adjusted icon sizes | {{Resource | action, spell1 | icon size = 25}} | ![]() ![]() |
Legacy examples
Markup | Renders as |
---|---|
{{Resource | invalid}} | ![]() |
{{Resource}} | ![]() |
{{Resource | supdie}} | ![]() |
{{Resource | SuPdIe | 2}} | ![]() |
{{Resource | supdie| forceplural=yes}} | ![]() |
{{Resource | ki | count = 200}} | ![]() |
{{Resource | lh | icononly = yes}} | ![]() |
{{Resource | movement m | count = 1.5}} | ![]() |
Costs: {{Resource | ki | count = 2 | icononly = yes}} | Costs: 2 ![]() |
Costs: {{Resource | l2 | count = 2 | nameonly = yes}} | Costs: ![]() |
Recover half of your max {{Resource | ki | forceplural = yes}}, once per short rest. | Recover half of your max ![]() |
{{Resource | type = ar | 1 | forceplural = yes}} | ![]() |
{{Resource | type = shadowspell3 | 1 }} | ![]() |
{{Resource | type = eyestalk | 1 }} | ![]() |
{{r|reaction}}s | ![]() |
Template data
Display an action resource with its accompanying icon.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Type | 1 type | A name of a resource or comma-separated list of resources. For shorter aliases for these options, refer to the full list on the template page. An optional count parameter for each resource can be specified after a ":" separator.
| String | required |
Count | 2 count | The number of the specified resources consumed. This is a deprecated parameter and only works for singular resources rather than lists of resources.
| String | deprecated |
Show links | show links | Show links to the relevant pages for the resources. | Boolean | optional |
Icons only | icons only icononly | Hide the resource name leaving just the resource icon and the count. The name will still be shown in a hover-over tooltip. | Boolean | optional |
Force plural | force plural forceplural | Force the output use the plural form even when count is 1. | Boolean | optional |