Module:Resource/doc

This module handles displaying resource costs. It can:

• Handle multiple resources at once. The input is a comma separated list of resource names.
• 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.
• Display in multiple formats suitable for inline usage or for compact table columns.

End users should invoke this module through the wrapper template: {{Resource}}.

File tree

• Module:Resource
  • Module:Resource/data: Defines all the resources and their associated icons, links, categories, etc.
  • Module:Resource/doc: Documentation page
• Template:Resource: Wrapper template for end users

Parameters

Parameter	Meaning
Unnamed parameter	A comma separated list of resources with an optional count parameter separated by : List → Term | Term, Term Term → Resource | Resource:Count Resource → (see below for valid values)
force plural	Boolean flag to force icon names to always use their plural forms. Default is no.
icons only	Boolean flag to show only the icon names. Full resource names are visible in hover-over tooltips. Default is no.
show links	Boolean flag to make resource names into links to the appropriate pages. Default is no.
icon size	Adjust the size of the resource icons. Default is 20 and for inline text, larger icons should not be used.

Resource types

The available resource types are as follows:

List of resources

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

Examples

Example	Markup	Renders as
Basic usage	{{#invoke: Resource | main | action}}	Action
Optional count specified	{{#invoke: Resource | main | ki:3 }}	3 Ki Points
Multiple resources	{{#invoke: Resource | main | action, bonus, spell1}}	Action +  Bonus Action +  Level 1 Spell Slot
Movement speed	{{#invoke: Resource | main | bonus, m:3 }}	Bonus Action +  3 m / 10 ft Movement Speed
Icons only	{{#invoke: Resource | main | action, bonus, spell1 | icons only = yes }}	+ +