Difference between revisions of "D&D 5E by Roll20/Roll Templates"
From Roll20 Wiki
Andreas J. (Talk | contribs) m |
Andreas J. (Talk | contribs) m |
||
| Line 13: | Line 13: | ||
==General Notes== | ==General Notes== | ||
*Anything that says it toggles something off/on means that if you put anything after the "=", including a space, that feature is turned on, if there is nothing after the "=", then it is off. | *Anything that says it toggles something off/on means that if you put anything after the "=", including a space, that feature is turned on, if there is nothing after the "=", then it is off. | ||
| − | *The macros using <code>atk</code>, <code>simple</code>, <code>npcatk</code>, and <code>atkdmg</code> generated by the sheet utilize <code>@{rtype}</code> in place of <code><nowiki>{{always/normal/advantage/disadvantage=1}} {{r2=[[1d20]]}}</nowiki></code>. This attribute would allow you to link whether a second d20 is rolled or not to what the settings of your sheet are. Since <code><nowiki>@{rtype}</nowiki></code> translates to <code><nowiki>{{query=1}} {{<advantage|disadvantage|always|normal>=1}} {{r2=[[1d20</nowiki></code> you will need to add the closing brackets and any attack modifiers you want directly afterwards in order to match the first attack roll. An example of such a macro would look like this: <code><nowiki>&{template:atkdmg} {{rname=rname}} {{attack=1}} {{r1=[[1d20+7 ]]}} @{rtype}+7]]}} {{damage=1}} {{dmg1flag=1}} {{dmg1=[[1d6+5]]}} {{dmg1type=dmg1type}} </nowiki></code> Note how <code>@{rtype}</code> is followed by <code>+7]]}}</code> in order to match the original attack roll of 1d20+7. | + | *The macros using <code>atk</code>, <code>simple</code>, <code>npcatk</code>, and <code>atkdmg</code> generated by the sheet utilize <code>@{rtype}</code> in place of <code><nowiki>{{always/normal/advantage/disadvantage=1}} {{r2=[[1d20]]}}</nowiki></code>. This attribute would allow you to link whether a second d20 is rolled or not to what the settings of your sheet are. Since <code><nowiki>@{rtype}</nowiki></code> translates to <code><nowiki>{{query=1}} {{<advantage|disadvantage|always|normal>=1}} {{r2=[[1d20]]}}</nowiki></code> you will need to add the closing brackets and any attack modifiers you want directly afterwards in order to match the first attack roll. |
| + | |||
| + | An example of such a macro would look like this: <code><nowiki>&{template:atkdmg} {{rname=rname}} {{attack=1}} {{r1=[[1d20+7 ]]}} @{rtype}+7]]}} {{damage=1}} {{dmg1flag=1}} {{dmg1=[[1d6+5]]}} {{dmg1type=dmg1type}} </nowiki></code> Note how <code>@{rtype}</code> is followed by <code>+7]]}}</code> in order to match the original attack roll of 1d20+7. | ||
*The roll templates have a hard-coded size and will not scale if the chat pane is resized or (with the exception of the description fields and fields in the NPC templates) if a field's contents are larger than the field's space in the template output. | *The roll templates have a hard-coded size and will not scale if the chat pane is resized or (with the exception of the description fields and fields in the NPC templates) if a field's contents are larger than the field's space in the template output. | ||
| Line 323: | Line 325: | ||
=See Also= | =See Also= | ||
| − | * | + | * {{repo|Roll20/roll20-character-sheets/tree/master/DD5thEditionLegacy Sheet sourecode}} - The HTML file contains to code for how the roll templates are defined. |
* [[Roll Templates]] - general info on how roll templates work | * [[Roll Templates]] - general info on how roll templates work | ||
* [[5E]] info on the other D&D 5E character sheets, that have their own roll templates that work differently | * [[5E]] info on the other D&D 5E character sheets, that have their own roll templates that work differently | ||
Revision as of 23:29, 31 January 2021
Attention: Roll20 is no longer maintaining this document on the community wiki. For the Official Documentation please visit Roll20's Help Center: Here.
Main Page: D&D 5E by Roll20
There are 10 roll templates provided by the D&D 5E by Roll20-character sheet.
See also the D&D5E by Roll20 NPC Attributes-page.
Contents |
General Notes
- Anything that says it toggles something off/on means that if you put anything after the "=", including a space, that feature is turned on, if there is nothing after the "=", then it is off.
- The macros using
atk,simple,npcatk, andatkdmggenerated by the sheet utilize@{rtype}in place of{{always/normal/advantage/disadvantage=1}} {{r2=[[1d20]]}}. This attribute would allow you to link whether a second d20 is rolled or not to what the settings of your sheet are. Since@{rtype}translates to{{query=1}} {{<advantage|disadvantage|always|normal>=1}} {{r2=[[1d20]]}}you will need to add the closing brackets and any attack modifiers you want directly afterwards in order to match the first attack roll.
An example of such a macro would look like this: &{template:atkdmg} {{rname=rname}} {{attack=1}} {{r1=[[1d20+7 ]]}} @{rtype}+7]]}} {{damage=1}} {{dmg1flag=1}} {{dmg1=[[1d6+5]]}} {{dmg1type=dmg1type}} Note how @{rtype} is followed by +7]]}} in order to match the original attack roll of 1d20+7.
- The roll templates have a hard-coded size and will not scale if the chat pane is resized or (with the exception of the description fields and fields in the NPC templates) if a field's contents are larger than the field's space in the template output.
Common Fields
Many of the fields used by the roll templates are common to all or most of the roll templates. See the example templates below to see which of the following fields a given template uses.
| Field | Value Type | Expected Value |
|---|---|---|
| advantage
always disadvantage normal |
Toggle | One of these four toggles can be set to determine whether one attack or check die is rolled (normal), both (always), both with the higher number grayed out (disadvantage), or both with the lower number grayed out (advantage). |
| ammo | Text | The name of the ammunition that the attack should spend. (See ammunition tracking.) |
| attack | Toggle | Whether or not the attack section of the template is shown. |
| charname | Text | The name of the character that generated this template. |
| crit | Toggle | Whether or not the critical damage result is shown. |
| crit1
crit2 |
Roll | The damage die and modifiers to use on a critical success. |
| damage | Toggle | Whether or not the damage section of the template is shown. |
| desc
description |
Text | A description of the attack, spell or NPC ability. |
| dmg1
dmg2 |
Roll | The damage die and modifiers to use. |
| dmg1flag
dmg2flag |
Toggle | Whether or not the damage result is shown. |
| dmg1type
dmg2type |
Text | The type of damage caused, such as "Bludgeoning" or "Poison". |
| hldmg | Roll | The additional damage die and modifiers to use when casting a spell at a higher level. |
| hldmgcrit | Roll | The damage die and modifiers to use on a critical success when casting a spell at a higher level. |
| mod | Number | The total of all modifiers to be added to an attack or check roll. |
| name | Text | The name of a spell or, in an NPC template, the name of the NPC that generated this template. |
| r1
r2 |
Roll | The die to roll in order to determine if an attack or check succeeds. |
| range | Text | The range of the attack, spell or NPC ability. |
| rname | Text | The name of the attack or NPC ability. |
| rnamec | Text | The name of the attack or NPC ability if it critically succeeds. |
| save | Toggle | Whether or not the save section of the template is shown. |
| saveattr | Text | The attribute that the target must roll a saving throw for. |
| savedc | Text | The DC that the target must beat with their saving throw. |
| savedesc | Text | The effect that occurs if the target succeeds their saving throw, such as "Half Damage". |
| spelllevel | Number | What level spell slot to expend when casting this spell. (See spell slot tracking.) |
Roll Templates
Description
Template
&{template:desc} {{desc=desc}}
Simple
Template
&{template:simple} {{rname=rname}} {{mod=mod}} {{r1=r1}} {{always=1}} {{r2=r2}} {{charname=charname}}
Character Sheet Examples
- Attribute Checks
- Saving Throws
- Skill Checks
Caveats
- In order for the r1 or r2 sections to be output, the normal | always | advantage | disadvantage field must be included.
Attack
Template
&{template:atk} {{mod=mod}} {{rname=rname}} {{rnamec=rnamec}} {{r1=r1}} {{always=1}} {{r2=r2}} {{range=range}} {{desc=desc}} {{spelllevel=spelllevel}} ammo=ammo {{charname=charname}}
Character Sheet Examples
- Spells and Attacks that require to hit rolls (Sheet setting 'Auto Damage Roll' must be set to 'Don't Auto Roll Damage')
Caveats
- In order for the r1 or r2 sections to be output, the normal | always | advantage | disadvantage field must be included.
- In order for the rname, rnamec and mod fields to be output, r1 and, if included, r2 must be a calculable roll value.
- In order for ammo to be correctly expended, rname must exactly match the name of a weapon that uses the correct ammunition field, r1 must be a calculable roll value and charname must resolve to the exact name of a character sheet.
Damage
Template
&{template:dmg} {{rname=rname}} {{range=range}} {{damage=1}} {{dmg1flag=1}} {{dmg1=dmg1}} {{dmg1type=dmg1type}} {{dmg2flag=1}} {{dmg2=dmg2}} {{dmg2type=dmg2type}} {{crit=1}} {{crit1=crit1}} {{crit2=crit2}} {{save=1}} {{saveattr=saveattr}} {{savedesc=savedesc}} {{savedc=savedc}} {{desc=desc}} {{hldmg=hldmg}} {{spelllevel=spelllevel}} ammo=ammo {{charname=charname}}
Character Sheet Examples
- Spells and Attacks that cause damage, but do not require a to hit roll.
Caveats
- In order for the hldmg section to be output, the hldmg field must be a calculable roll value.
- In order for the spelllevel field to properly expend the correct spell slot, the dmg1 field must be a calculable roll value and charname must resolve to match the exact name of a character sheet.
- In order for ammo to be correctly expended, rname must exactly match the name of a weapon that uses the correct ammunition field, r1 must be a calculable roll value and charname must resolve to the exact name of a character sheet.
Attack & Damage
Template
&{template:atkdmg} {{mod=mod}} {{rname=rname}} {{r1=r1}} {{always=1}} {{r2=r2}} {{attack=1}} {{range=range}} {{damage=1}} {{dmg1flag=1}} {{dmg1=dmg1}} {{dmg1type=dmg1type}} {{dmg2flag=1}} {{dmg2=dmg2}} {{dmg2type=dmg2type}} {{crit1=crit1}} {{crit2=crit2}} {{save=1}} {{saveattr=saveattr}} {{savedesc=savedesc}} {{savedc=savedc}} {{desc=desc}} {{hldmg=hldmg}} {{spelllevel=spelllevel}} ammo=ammo {{charname=charname}}
Character Sheet Examples
- Spells and Attacks that require a to hit roll and cause damage. (Sheet setting 'Auto Damage Roll' must be set to 'Auto Roll Damage & Crit')
Caveats
- In order for the r1 or r2 sections to be output, the normal | always | advantage | disadvantage field must be included.
- In order for the hldmg section to be output, the hldmg field must be a calculable roll value.
- In order for the spelllevel field to properly expend the correct spell slot, the dmg1 field must be a calculable roll value and charname must resolve to match the exact name of a character sheet.
- In order for ammo to be correctly expended, rname must exactly match the name of a weapon that uses the correct ammunition field, r1 must be a calculable roll value and charname must resolve to the exact name of a character sheet.
Spell
Template
&{template:spell} {{level=school level}} {{name=name}} {{castingtime=castingtime}} {{range=range}} {{target=target}} {{v=1}} {{s=1}} {{m=1}} {{material=material}} {{duration=duration}} {{description=description}} {{athigherlevels=athigherlevels}} {{ritual=1}} {{concentration=1}} {{charname=charname}}
Character Sheet Examples
- Spells with 'Output' set to 'Spellcard'.
Caveats
- In order for the level field to properly expend the correct spell slot, the charname must resolve to match the exact name of a character sheet. (See spell slot tracking.)
Unique Fields
| Field | Value Type | Expected Value |
|---|---|---|
| athigherlevels | Text | A description of the spell's effects when cast using higher level spell slots. |
| castingtime | Text | How many and what type of action casting this spell takes, such as '1 Action' or '1 Reaction'. |
| concentration | Toggle | Whether or not concentration is shown in the duration section. |
| duration | Text | How long the spell's effects lasts. |
| level | Text | The name of the spell's school followed by its spell level, such as "Divination 3". |
| m | Toggle | Whether or not the "M" for materials is shown in components section. |
| material | Text | The materials required to cast the spell. |
| ritual | Toggle | Whether or not the ritual cast option is shown. |
| s | Toggle | Whether or not the "S" for somatic is shown in components section. |
| target | Text | What the spells targets, such as "1 Friendly Creature". |
| v | Toggle | Whether or not the "V" for verbal is shown in components section. |
Traits
&{template:traits} {{name=Traits Name}} {{source=Source:Source type}} {{description=Trait description}}
- Rolls from the Features&Traits section use this rolltemplate.
- If Features & Traits are used, {{source=}}-section gets filled with the
Source+Source Type, of the trait, which in the example is "Class" and "Rogue"
NPC Action
Template
&{template:npcaction} {{attack=1}} {{damage=1}} {{dmg1flag=1}} {{dmg2flag=1}} {{name=name}} {{rname=rname}} {{r1=r1}} {{always=1}} {{r2=r2}} {{dmg1=dmg1}} {{dmg1type=dmg1type}} {{crit1=crit1}} {{dmg2=dmg2}} {{dmg2type=dmg2type}} {{crit2=crit2}} {{description=description}}
Character Sheet Examples
- NPC Actions that require a to hit roll and cause damage. (Sheet setting 'Auto Damage Roll' must be set to 'Auto Roll Damage & Crit')
Caveats
- In order for the r1 or r2 sections to be output, the normal | always | advantage | disadvantage field must be included.
NPC Attack
Template
&{template:npcatk} {{attack=1}} {{name=name}} {{rname=rname}} {{rnamec=rnamec}} {{r1=r1}} {{always=1}} {{r2=r2}} {{description=description}}
Character Sheet Examples
- NPC Actions that require a to hit roll. (Sheet setting 'Auto Damage Roll' must be set to 'Don't Auto Roll Damage')
Caveats
- In order for the rname field to be output, r1 and, if included, r2 must be a calculable roll value.
- In order for the r1 or r2 sections to be output, the normal | always | advantage | disadvantage field must be included.
NPC Damage
Template
&{template:npcdmg} {{damage=1}} {{dmg1flag=1}} {{dmg2flag=1}} {{dmg1=dmg1}} {{dmg1type=dmg1type}} {{dmg2=dmg2}} {{dmg2type=dmg2type}} {{crit=1}} {{crit1=crit1}} {{crit2=crit2}}
Character Sheet Examples
- NPC Actions that cause damage. (Sheet setting 'Auto Damage Roll' must be set to 'Don't Auto Roll Damage')
See Also
- Sheet sourecode - The HTML file contains to code for how the roll templates are defined.
- Roll Templates - general info on how roll templates work
- 5E info on the other D&D 5E character sheets, that have their own roll templates that work differently
