Template:Resource

Template documentation

[view] [edit] [history] [purge]

Shortcut

• {{r}}

Display action resources, including specific class resources, in a standardized and consistent format. This template is intended to be inline.

Usage

{{Resource | <type> | [count] | [icononly] | [nameonly] | [forceplural]}}

< ... > denotes mandatory parameters and [ ... ] denotes optional parameters.

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 the resources in the game.

name parameter

Resource	Input
Actions	action
Bonus actions	bonus, bonus action, ba
Reactions	reaction
Movement	movement (no value)
Movement	movement m (value in meters)
Movement	movement ft (value in feet)
Movement (Half cost)	half movement
Arcane Arrows	aa, arcarr, arcane arrow
Arcane Recovery Charges	ar, arcrec, arcane recovery
Bardic Inspiration Charges	bi, bardin, bardic inspiration
Bladesong Power	bsp, bladesong, bladesong power
Channel Divinity Charges	cd, chadiv, channel divinity
Channel Oath Charges	co, chaoat, channel oath
Cosmic Omens	cos, cosmic, cosmic omen
Fungal Infestation Charges	fi, fnginf, fungal infestation
Ki Points	ki
Level 1 Spell Slots	l1, s1, spell1, level1
Level 2 Spell Slots	l2, s2, spell2, level2
Level 3 Spell Slots	l3, s3, spell3, level3
Level 4 Spell Slots	l4, s4, spell4, level4
Level 5 Spell Slots	l5, s5, spell5, level5
Level 6 Spell Slots	l6, s6, spell6, level6
Level 3 Shadow Spell Slots	shadowspell3, ss3, shadowlevel3, sl3
Lay on Hands Charges	lh, layonh, lay on hands
Natural Recovery Charges	nr, natrec, natural recovery
Rage Charges	rg, rage
Sorcery Points	sp, srcpnt, sorcery
Star Maps	sm, star map, star maps
Superiority Dice	sd, supdie, superiority die
War Priest Charges	wp, warpri, war priest
Wild Shape Charges	ws, wldshp, wild shape, wildshape
Tides of Chaos Charges	toc, tides of chaos
Luck Points	lp, lukpnt, luck, luck point
Writhing Currents	wc, writhing, writhing current

Examples

Markup	Renders as
{{Resource | invalid}}	invalid
{{Resource}}	UNDEFINED
{{Resource | supdie}}	Superiority Die
{{Resource | SuPdIe | 2}}	2 Superiority Dice
{{Resource | supdie| forceplural=yes}}	Superiority Dice
{{Resource | ki | count = 200}}	200 Ki Points
{{Resource | lh | icononly = yes}}
{{Resource | movement m | count = 1.5}}	1.5 m / 5 ft Movement
Costs: {{Resource | ki | count = 2 | icononly = yes}}	Costs: 2
Costs: {{Resource | l2 | count = 2 | nameonly = yes}}	Costs: 2  Level 2 Spell Slots
Recover half of your max {{Resource | ki | forceplural = yes}}, once per short rest.	Recover half of your max  Ki Points, once per short rest.
{{Resource | type = ar | 1 | forceplural = yes}}	Arcane Recovery Charges
{{Resource | type = shadowspell3 | 1 }}	Level 3 Shadow Spell Slot
{{Resource | type = eyestalk | 1 }}	Eyestalk Action
{{r|reaction}}s	Reactions

Template data

Display an action resource with its accompanying icon.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Type	1 type	The name of the resource. For shorter aliases for these options, refer to the full list on the template page. Suggested values action bonus reaction movement movement m spell1 spell2 spell3 spell4 spell5 spell6 arcane arrow arcane recovery bardic inspiration bladesong power channel divinity channel oath cosmic omen fungal infestation ki lay on hands luck point natural recovery rage shadowspell3 sorcery star map superiority die tides of chaos war priest wild shape	String	required
Count	2 count	The number of the specified resources consumed. Default 1	String	optional
Name only	nameonly	Hide the resource icon leaving just the name of resource and the count.	Boolean	optional
Icon only	icononly	Hide the resource name leaving just the resource icon and the count.	Boolean	optional
Force plural	forceplural	Force the output use the plural form even when count is 1.	Boolean	optional

The above documentation is transcluded from Template:Resource/doc. (edit | history)
Please add categories to the /doc subpage. Subpages of this template.