Template:Resource: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
(Added "half movement" option for use with abilities like Fly that use movement at half cost)
No edit summary
Line 1: Line 1:
<includeonly><span class="bg3wiki-resource-template">{{trim| {{#lvardef: type|UNDEFINED}} {{#lvardef: icon|Alert Icon.png}}{{#lvardef:isplural|0}}{{#lvardef:icononly|0}}
<includeonly><span class="bg3wiki-resource-template">{{trim| {{#lvardef: type|UNDEFINED}} {{#lvardef: icon|Alert Icon.png}}{{#lvardef:isplural|0}}{{#lvardef:icononly|0}}{{#lvardef:nameonly|0}}
{{#lvardef: count | 1}}<!--if count is empty, set it to 1--> <!--this is at the front -->
{{#lvardef: count | 1}}<!--if count is empty, set it to 1--> <!--this is at the front -->
{{#if: {{{type|}}} | {{#lvardef:type|{{{type|}}}}}|{{#if: {{{1|}}} | {{#lvardef:type|{{{1}}}}}}}}}
{{#if: {{{type|}}} | {{#lvardef:type|{{{type|}}}}}|{{#if: {{{1|}}} | {{#lvardef:type|{{{1}}}}}}}}}
Line 32: Line 32:
| toc | tides of chaos = {{#lvardef: type|Tides of Chaos Charge{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }}{{#lvardef:icon|Tides of Chaos Resource 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}}
| lp | lukpnt | luck point = {{#lvardef: type|Luck Point{{#ifexpr: {{#lvar: isplural}} > 0 |s}} }}{{#lvardef:icon|Luck Point Resource Icon.png}}
}}{{#ifexpr: {{#lvar: isplural}} > 0 | {{#if: {{{forceplural|}}}||{{#lvar: count}}}}}}{{SmallIcon|{{#lvar:icon}}}}{{#if: {{{icononly|}}}||{{#lvar: type}}}}}}{{#ifeq: {{#lvar: icon}}|Alert Icon.png|[[Category:Pages with unknown resources]]}}</span></includeonly><noinclude>
}}{{#ifexpr: {{#lvar: isplural}} > 0 | {{#if: {{{forceplural|}}}||{{#lvar: count}}}}}}{{#if: {{{nameonly|}}}|{{Nbts}}|{{SmallIcon|{{#lvar:icon}}}}}}{{#if: {{{icononly|}}}||{{#lvar: type}}}}}}{{#ifeq: {{#lvar: icon}}|Alert Icon.png|[[Category:Pages with unknown resources]]}}</span></includeonly><noinclude>
=What is this?=
=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''.
Line 38: Line 38:
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 53: Line 53:
* <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>
Line 175: Line 178:
| <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.

Revision as of 09:53, 22 November 2023

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 as supdie, 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

name parameter
Resource Input
Actions action
Bonus actions bonus
Reactions reaction
Movement movement
Movement (Half cost) half movement
Arcane Recovery Charges ar, arcrec, arcane recovery
Bardic Inspiration Charges bi, bardin, bardic inspriation
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
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 | count = 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}}