Template:Resource: Difference between revisions
Jump to navigation
Jump to search
HiddenDragon (talk | contribs) (Fixed count/distance) |
HiddenDragon (talk | contribs) mNo edit summary |
||
(25 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
<includeonly | <includeonly>{{trim| | ||
{{#lvardef: count | 1}} | |||
{{#if: {{{type|}}} | {{#lvardef:type|{{{type|}}}}}|{{#if: {{{1|}}} | {{#lvardef:type|{{{1}}}}}}}}} | {{#lvardef: type | UNDEFINED }} | ||
{{#if: {{{count|}}}| {{#lvardef: count| {{{count|}}}}}|{{#if: {{{2|}}} | {{#lvardef:count|{{{2|}}}}}}}}} | {{#lvardef: icon | Alert Icon.png }} | ||
{{#ifexpr: {{#lvar: count}} > 1 | {{#lvardef:isplural|1}}}} <!-- | {{#lvardef: isplural | 0 }} | ||
{{#if: {{{forceplural|}}} | {{#ifeq: {{{forceplural|}}} | yes | {{#lvardef:isplural|1}} | {{#lvardef:isplural|0}}}}}} <!-- | {{#lvardef: icononly | 0 }} | ||
{{#switch: {{lc:{{#lvar: type}}}} | {{#lvardef: nameonly | 0 }} | ||
| action = {{#lvardef: type| | |||
| bonus = {{#lvardef: type| | {{#lvardef: count | 1 }} | ||
| reaction = {{#lvardef: type| | |||
| movement = {{#lvardef: type| | {{#if: {{{type|}}} | ||
| {{#lvardef: type | {{{type|}}} }} | |||
| | | {{#if: {{{1|}}} | {{#lvardef: type | {{{1}}} }} }} | ||
| | }} | ||
| | {{#if: {{{count|}}} | ||
| | | {{#lvardef: count | {{{count|}}} }} | ||
| | | {{#if: {{{2|}}} | {{#lvardef: count | {{{2|}}} }} }} | ||
| | }} | ||
| | |||
| | {{#ifexpr: {{#lvar: count}} > 1 | {{#lvardef: isplural | 1 }} }} | ||
| | |||
| | <!--there may be special cases where you want to have plural forms without a count (i.e. explanations)--> | ||
| | {{#if: {{{forceplural|}}} | ||
| | | {{#ifeq: {{{forceplural|}}} | yes | {{#lvardef:isplural|1}} | {{#lvardef:isplural|0}} }} | ||
| | }} | ||
| | |||
| | <!-- lc is to make the input all lower case, so that case is not my biggest priority --> | ||
| | {{#switch: {{lc: {{#lvar:type}} }} | ||
| | |||
| | | action = | ||
| | {{#lvardef: type | {{#if: {{{nameonly|}}}|Action|[[Action]]}}{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | ||
{{#lvardef: icon | Action Icon.png }} | |||
=What is this?= | |||
| bonus = | |||
{{#lvardef: type | {{#if: {{{nameonly|}}}|Bonus action|[[Bonus action]]}}{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Bonus Action Icon.png }} | |||
| reaction = | |||
{{#lvardef: type | {{#if: {{{nameonly|}}}|Reaction|[[Reaction]]}}{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Reaction Icon.png }} | |||
| movement = | |||
{{#lvardef: type | {{#if: {{{nameonly|}}}|Movement|[[Movement speed|Movement]]}} }} | |||
{{#lvardef: icon | Movement Speed Icon.png }} | |||
{{#if: {{{count|}}} {{{2|}}} | |||
| {{#lvardef: count | {{color|red|(ERROR: Use <code>movement m</code> or <code>movement ft</code>.)}} }} | |||
[[Category:Pages with errors]] | |||
}} | |||
| movement m = | |||
{{#lvardef: type | {{#if: {{{nameonly|}}}|Movement|[[Movement speed|Movement]]}} }} | |||
{{#lvardef: icon | Movement Speed Icon.png }} | |||
{{#if: {{{count|}}} | |||
| {{#lvardef: count | {{Distance | m = {{{count|}}} }} }} | |||
| {{#if: {{{2|}}} | {{#lvardef: count | {{Distance | m = {{{2|}}} }} }} }} | |||
}} | |||
| movement ft = | |||
{{#lvardef: type | {{#if: {{{nameonly|}}}|Movement|[[Movement speed|Movement]]}} }} | |||
{{#lvardef: icon | Movement Speed Icon.png }} | |||
<!-- Backwards compatibility only; this isn't meant to be used with a value --> | |||
{{#if: {{{count|}}} | |||
| {{#lvardef: count | {{Distance | ft = {{{count|}}} }} }} | |||
| {{#if: {{{2|}}} | {{#lvardef: count | {{Distance | ft = {{{2|}}} }} }} }} | |||
}} | |||
| half movement = | |||
{{#lvardef: type | {{#if: {{{nameonly|}}}|Movement (Half cost)|[[Movement speed|Movement]] (Half cost)}} }} | |||
{{#lvardef: icon | Movement Speed Icon.png }} | |||
| sd | supdie | superiority die = | |||
{{#lvardef: type | Superiority {{#ifexpr: {{#lvar: isplural}} > 0 |Dice|Die}} }} | |||
{{#lvardef: icon | Superiority Die d8 Icon.png }} | |||
| fi | fnginf = | |||
{{#lvardef: type |Fungal Infestation Charge{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Fungal Infestation Charge Icon.png }} | |||
| ki = | |||
{{#lvardef: type | Ki Point{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Monk Ki Icon.png }} | |||
| ws | wldshp | wild shape = | |||
{{#lvardef: type | Wild Shape Charge{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Wild Shape Charges Icon.png | |||
}} | |||
| spell1 | s1 | level1 | l1 = | |||
{{#lvardef: type | Level 1 Spell Slot{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Spell Slot Icon.png }} | |||
| spell2 | s2 | level2 | l2 = | |||
{{#lvardef: type | Level 2 Spell Slot{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Spell Slot Icon.png }} | |||
| spell3 | s3 | level3 | l3 = | |||
{{#lvardef: type | Level 3 Spell Slot{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Spell Slot Icon.png }} | |||
| spell4 | s4 | level4 | l4 = | |||
{{#lvardef: type | Level 4 Spell Slot{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Spell Slot Icon.png }} | |||
| spell5 | s5 | level5 | l5 = | |||
{{#lvardef: type | Level 5 Spell Slot{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Spell Slot Icon.png }} | |||
| spell6 | s6 | level6 | l6 = | |||
{{#lvardef: type | Level 6 Spell Slot{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Spell Slot Icon.png }} | |||
| ar | arcrec | arcane recovery = | |||
{{#lvardef: type | Arcane Recovery Charge{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Arcane Recovery Charges Icons.png }} | |||
| bi | bardin | bardic inspiration = | |||
{{#lvardef: type | Bardic Inspiration Charge{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Bardic Inspiration Resource Icon.png }} | |||
| cd | chadiv | channel divinity = | |||
{{#lvardef: type | Channel Divinity Charge{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Channel Divinity Charges Icons.png }} | |||
| co | chaoat | channel oath = | |||
{{#lvardef: type | Channel Oath Charge{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Channel Oath Icon.png }} | |||
| rg | rage = | |||
{{#lvardef: type | Rage Charge{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Rage Charges Icons.png }} | |||
| sp | srcpnt | sorcery = | |||
{{#lvardef: type | Sorcery Point{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Sorcery Points Icons.png }} | |||
| wp | warpri | war priest = | |||
{{#lvardef: type | War Priest Charge{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | War Priest Charges Icon.png}} | |||
| lh | layonh | lay on hands = | |||
{{#lvardef: type | Lay on Hands Charge{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Lay on Hands Resource Icon.png }} | |||
| nr | natrec | natural recovery = | |||
{{#lvardef: type | Natural Recovery Charge{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Natural Recovery Charges Icon.png }} | |||
| toc | tides of chaos = | |||
{{#lvardef: type | Tides of Chaos Charge{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Tides of Chaos Resource Icon.png }} | |||
| lp | lukpnt | luck point = | |||
{{#lvardef: type | Luck Point{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Luck Point Resource Icon.png }} | |||
| es | eyestalk | eyestalk action = | |||
{{#lvardef: type | Eyestalk Action{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Eyestalk Action Icon.png }} | |||
| shadowspell3 | ss3 | shadowlevel3 | sl3 = | |||
{{#lvardef: type | Level 3 Shadow Spell Slot{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }} | |||
{{#lvardef: icon | Shadow Spell Slot Icon.png }} | |||
| #default = | |||
{{Main namespace only|[[Category:Pages with unknown resources]]}} | |||
<!-- end switch --> | |||
}} | |||
<!-- end trim (variable definitions) --> | |||
}}<span class="bg3wiki-resource-template">{{#ifexpr: {{#lvar: isplural}} > 0 | |||
| {{#if: {{{forceplural|}}} | | {{#lvar: count}} }} | |||
}}{{#if: {{{nameonly|}}} | |||
| {{Nbts}} | |||
| {{SmallIcon | {{#lvar:icon}} }} | |||
}}{{#if: {{{icononly|}}} | |||
| <!-- blank --> | |||
| {{#lvar: type}} | |||
}}</span></includeonly><noinclude> | |||
==What is this?== | |||
This is a template for a quicker and more standardized manner of typing out the class-specific resource. This template is intended to be ''inline''. | This is a template for a quicker and more standardized manner of typing out the class-specific resource. This template is intended to be ''inline''. | ||
If there are any missing resources, don't hesitate to contribute! | If there are any missing resources, don't hesitate to contribute! | ||
=Usage= | ==Usage== | ||
<pre>{{Resource | <type> | [count] | [icononly] | [forceplural]}}</pre> | <pre>{{Resource | <type> | [count] | [icononly] | [nameonly] | [forceplural]}}</pre> | ||
---- | ---- | ||
<br/><code><></code> Denotes mandatory parameters. | <br/><code><></code> Denotes mandatory parameters. | ||
Line 52: | Line 199: | ||
* <code>icononly</code> | * <code>icononly</code> | ||
** Show the icon only, leaving the count there as well. | ** Show the icon only, leaving the count there as well. | ||
** Can be used to just quickly get the icon without the text. | |||
* <code>nameonly</code> | |||
** Show the name only, leaving the count there as well. | |||
** Can be used to just quickly get the icon without the text. | ** Can be used to just quickly get the icon without the text. | ||
* <code>forceplural</code> | * <code>forceplural</code> | ||
** Forces the text to be plural, changing some of the words to their plural form | ** Forces the text to be plural, changing some of the words to their plural form | ||
** The most obvious use of this is for Superiority Die (or Dices in plural). | ** The most obvious use of this is for Superiority Die (or Dices in plural). | ||
=Quick | ==Quick reference== | ||
{| class="wikitable mw-collapsible" | {| class="wikitable mw-collapsible" | ||
|+ name parameter | |+ name parameter | ||
Line 72: | Line 222: | ||
|- | |- | ||
| {{Resource|movement|forceplural=yes}} | | {{Resource|movement|forceplural=yes}} | ||
| {{C|movement}} | | {{C|movement}} (no value) | ||
|- | |||
| {{Resource|movement m|forceplural=yes}} | |||
| {{C|movement m}} (value in meters) | |||
|- | |||
| {{Resource|movement ft|forceplural=yes}} | |||
| {{C|movement ft}} (value in feet) | |||
|- | |||
| {{Resource|half movement|forceplural=yes}} | |||
| {{C|half movement}} | |||
|- | |||
|- | |- | ||
| {{Resource|ar|forceplural=yes}} | | {{Resource|ar|forceplural=yes}} | ||
Line 78: | Line 238: | ||
|- | |- | ||
| {{Resource|bi|forceplural=yes}} | | {{Resource|bi|forceplural=yes}} | ||
| {{C|bi, bardin, bardic | | {{C|bi, bardin, bardic inspiration}} | ||
|- | |- | ||
| {{Resource|cd|forceplural=yes}} | | {{Resource|cd|forceplural=yes}} | ||
Line 87: | Line 247: | ||
|- | |- | ||
| {{Resource|fi|forceplural=yes}} | | {{Resource|fi|forceplural=yes}} | ||
| {{C|fi}} | | {{C|fi, fnginf}} | ||
|- | |- | ||
| {{Resource|ki|forceplural=yes}} | | {{Resource|ki|forceplural=yes}} | ||
Line 109: | Line 269: | ||
| {{Resource|l6|forceplural=yes}} | | {{Resource|l6|forceplural=yes}} | ||
| {{C|l6, s6, spell6, level6}} | | {{C|l6, s6, spell6, level6}} | ||
|- | |||
| {{Resource|shadowlevel3|forceplural=yes}} | |||
| {{C|shadowspell3, ss3, shadowlevel3, sl3}} | |||
|- | |- | ||
| {{Resource|lh|forceplural=yes}} | | {{Resource|lh|forceplural=yes}} | ||
Line 137: | Line 300: | ||
| {{C|lp, lukpnt, luck point}} | | {{C|lp, lukpnt, luck point}} | ||
|} | |} | ||
=Examples= | =Examples= | ||
{| class="wikitable mw-collapsible" | {| class="wikitable mw-collapsible" | ||
Line 163: | Line 327: | ||
| <pre>{{Resource | lh | icononly = yes}}</pre> | | <pre>{{Resource | lh | icononly = yes}}</pre> | ||
|- | |- | ||
| {{Resource | movement | count = 5}} | | {{Resource | movement m | count = 1.5}} | ||
| <pre>{{Resource | movement | count = 5}}</pre> | | <pre>{{Resource | movement m | count = 1.5}}</pre> | ||
|- | |- | ||
| Costs: {{Resource | ki | count = 2 | icononly = yes}} | | Costs: {{Resource | ki | count = 2 | icononly = yes}} | ||
| <pre>Costs: {{Resource | ki | count = 2 | icononly = yes}}</pre> | | <pre>Costs: {{Resource | ki | count = 2 | icononly = yes}}</pre> | ||
|- | |- | ||
| Restores: {{Resource | l2 | count = 2}} | | Restores: {{Resource | l2 | count = 2 | nameonly = yes}} | ||
| <pre>Costs: {{Resource | l2 | count = 2}}</pre> | | <pre>Costs: {{Resource | l2 | count = 2 | nameonly = yes}}</pre> | ||
|- | |- | ||
| Recover half of your max {{Resource | ki | forceplural = yes}}, once per short rest. | | Recover half of your max {{Resource | ki | forceplural = yes}}, once per short rest. | ||
Line 178: | Line 342: | ||
| <pre>{{Resource | type = ar | 1 | forceplural = yes}}</pre> | | <pre>{{Resource | type = ar | 1 | forceplural = yes}}</pre> | ||
|- | |- | ||
| {{Resource | type = shadowspell3 | 1 }} | |||
| <pre>{{Resource | type = shadowspell3 | 1 }}</pre> | |||
|- | |||
| 1 {{Resource | type = eyestalk | 1 }} | |||
| <pre>{{Resource | type = eyestalk | 1 }}</pre> | |||
|} | |||
</noinclude> | </noinclude> |
Latest revision as of 05:23, 30 June 2024
What is this?
This is a template for a quicker and more standardized manner of typing out the class-specific resource. This template is intended to be inline.
If there are any missing resources, don't hesitate to contribute!
Usage
{{Resource | <type> | [count] | [icononly] | [nameonly] | [forceplural]}}
<>
Denotes mandatory parameters.
type
- See below for a table of what you can input here.
type =
is optional; you may just type the type name as long as its the first parameter.type = supdie
is the same assupdie
, AS LONG AS THEY ARE IN THE FIRST PARAMETER.
[]
Denotes optional parameters.
count
- The number of resources.
- Any number above 2 will be shown to the left of the icon, otherwise it will be hidden. (See Examples)
icononly
- Show the icon only, leaving the count there as well.
- Can be used to just quickly get the icon without the text.
nameonly
- Show the name only, leaving the count there as well.
- Can be used to just quickly get the icon without the text.
forceplural
- Forces the text to be plural, changing some of the words to their plural form
- The most obvious use of this is for Superiority Die (or Dices in plural).
Quick reference
Resource | Input |
---|---|
Actions | action
|
Bonus actions | bonus
|
Reactions | reaction
|
Movement | movement (no value)
|
Movement | movement m (value in meters)
|
Movement | movement ft (value in feet)
|
Movement (Half cost) | half movement
|
Arcane Recovery Charges | ar, arcrec, arcane recovery
|
Bardic Inspiration Charges | bi, bardin, bardic inspiration
|
Channel Divinity Charges | cd, chadiv, channel divinity
|
Channel Oath Charges | co, chaoat, channel oath
|
Fungal Infestation Charges | fi, fnginf
|
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
|
Superiority Dice | sd, supdie, superiority die
|
War Priest Charges | wp, warpri, war priest
|
Wild Shape Charges | ws, wldshp, wild shape
|
Tides of Chaos Charges | toc, tides of chaos
|
Luck Points | lp, lukpnt, luck point
|
Examples
Output | Input |
---|---|
invalid | {{Resource | invalid}} |
UNDEFINED | {{Resource}} |
Superiority Die | {{Resource | supdie}} |
2Superiority Dice | {{Resource | SuPdIe | 2}} |
Superiority Dice | {{Resource | supdie| forceplural=yes}} |
200Ki Points | {{Resource | ki | count = 200}} |
{{Resource | lh | icononly = yes}} | |
1.5 m / 5 ftMovement | {{Resource | movement m | count = 1.5}} |
Costs: 2 | Costs: {{Resource | ki | count = 2 | icononly = yes}} |
Restores: 2 Level 2 Spell Slots | Costs: {{Resource | l2 | count = 2 | nameonly = yes}} |
Recover half of your max Ki Points, once per short rest. | Recover half of your max {{Resource | ki | forceplural = yes}}, once per short rest. |
Arcane Recovery Charges | {{Resource | type = ar | 1 | forceplural = yes}} |
Level 3 Shadow Spell Slot | {{Resource | type = shadowspell3 | 1 }} |
1 Eyestalk Action | {{Resource | type = eyestalk | 1 }} |