Revision as of 05:45, 8 April 2017 (view source) Lex T. (Talk | contribs) (→‎&{template:npcdmg}) ← Older edit		Revision as of 08:51, 8 April 2017 (view source) Lex T. (Talk | contribs) (→‎Common Fields) Newer edit →
Line 28:		Line 28:
	The 5e OGL sheet has different styling depending on if you are using it in a custom 5e game or in a game started from a module (such as Lost Mines of Phandelver or Storm King's Thunder). These styling differences extend to the output of the roll templates, but do not change the syntax described below for using the roll template.		The 5e OGL sheet has different styling depending on if you are using it in a custom 5e game or in a game started from a module (such as Lost Mines of Phandelver or Storm King's Thunder). These styling differences extend to the output of the roll templates, but do not change the syntax described below for using the roll template.
−	==Common Fields==	+	{| class="wikitable"
−	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.	+	! style="font-weight: bold;" | Field
−	*mod: what goes in the mod field	+	! style="font-weight: bold;" | Value Type
−	*rname: what goes in the name field on a standard roll. Apparently does not work in custom atk template macros.	+	! style="font-weight: bold;" | Expected Value
−	*rnamec: what goes in the name field on a critical roll. Apparently does not work in custom atk template macros.	+	|-
−	*r1: the first roll	+	| advantage
−	*always/advantage/disadvantage/normal*: formats for always rolling advantage/disadvantage, greying out the lower roll, greying out the higher roll, only rolling once respectively	+	always
−	*r2: the second roll. Not displayed if the normal toggle is on	+	disadvantage
−	*range: range of the action	+	normal
−	*desc: attack description/text	+	| Toggle
−	*ammo: not an actual roll template field; see the [[5th Edition OGL by Roll20#Automatic Ammunition Tracking|ammunition tracking]] section of the 5e OGL wiki page.	+	| 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).
−	*charname: adds the character’s name to the roll	+	|-
−	*attack: toggles formatting for merging with an attack rolled without damage, has no effect in the atkdmg template	+	| ammo
−	*damage: no apparent effect	+	| Text
−	*dmg1flag/dmg2flag: toggles appearance of the indicated damage field	+	| The name of the ammunition that the attack should spend. (See ammunition tracking.)
−	*dmg1/dmg2: The damage roll	+	|-
−	*dmg1type/dmg2type: The type of the corresponding damage	+	| attack
−	*save: Toggles the save DC area to be displayed/hidden.	+	| Toggle
−	*saveattr: What save the target needs to attempt	+	| Whether or not the attack section of the template is shown.
−	*savedesc: What happens on a save	+	|-
−	*savedc: The DC of the save; the text “DC” is displayed regardless of what is entered	+	| charname
−	*description: description/text field in spell/NPC templates	+	| 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.
		+	|-
		+	| 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.
		+	|}
		+
	==&{template:desc}==		==&{template:desc}==
	[[File:OGL Description Template.png|200px|right|none]]<nowiki>&{template:desc} {{desc=DESCRIPTION}}</nowiki><div style="clear: both"></div>		[[File:OGL Description Template.png|200px|right|none]]<nowiki>&{template:desc} {{desc=DESCRIPTION}}</nowiki><div style="clear: both"></div>

---

Revision as of 08:51, 8 April 2017

There are 9 roll templates provided by the 5e OGL character sheet by Roll20:

Template	Sheet Roll Example	Formatting Notes
&{template:desc}	None
&{template:simple}	PC Ability/Skill Checks
&{template:atk}	PC attack when autoroll damage is off	Formats command buttons as hyperlink text "rname"/"rnamec" fields do not show up if there is no inline roll in r1 or r2 Inline rolls in the description field are formatted to take up an entire line with a yellow bar.
&{template:dmg}	PC damage roll	Description, rname, and charname fields are shown based on toggles
&{template:atkdmg}	PC attack when autoroll damage is on
&{template:spell}	PC spell not marked as an attack	Component label is displayed regardless of output options
&{template:npcaction}	Generic NPC action
&{template:npcatk}	NPC attack	Formats command buttons as hyperlink text
&{template:npcdmg}	NPC dmg roll

Contents 1 Style Differences 2 &{template:desc} 3 &{template:simple} 4 &{template:atk} 5 &{template:dmg} 6 &{template:atkdmg} 7 &{template:spell} 8 &{template:npcaction} 9 &{template:npcatk} 10 &{template:npcdmg} 11 General Notes

Style Differences

The 5e OGL sheet has different styling depending on if you are using it in a custom 5e game or in a game started from a module (such as Lost Mines of Phandelver or Storm King's Thunder). These styling differences extend to the output of the roll templates, but do not change the syntax described below for using the roll template.

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.
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.

&{template:desc}

&{template:desc} {{desc=DESCRIPTION}}

&{template:simple}

&{template:simple} {{rname=rname}} {{mod=mod}} {{r1=r1}} {{query=1}} {{normal=1}} {{r2=r2}} {{charname=charname}}

&{template:atk}

&{template:atk} {{mod=mod}} {{rname=rname}} {{rnamec=rnamec}} {{r1=r1}} {{query=1}} {{normal=1}} {{r2=r2}} {{range=range}} {{desc=desc}} {{spelllevel=spelllevel}} ammo=ammo {{charname=charname}}

&{template:dmg}

&{template:dmg} {{rname=rname}} {{attack=0}} {{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}}

&{template:atkdmg}

&{template:atkdmg} {{mod=mod}} {{rname=rname}} {{r1=r1}} {{query=1}} {{normal=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}}

&{template:spell}

&{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}}

• target: populates the target field
• v/s/m: toggles showing/hiding V, S, M(and the specific material component) after the components label
• concentration: toggles show/hide of “concentration” in duration

&{template:npcaction}

&{template:npcaction} {{attack=1}} {{damage=1}} {{dmg1flag=1}} {{name=name}} {{rname=rname}} {{r1=r1}} {{query=1}} {{normal=1}} {{r2=r2}} {{dmg1=dmg1}} {{dmg1type=damagetype}} {{dmg2=dmg2}} {{dmg2type=damagetype2}} {{crit1=crit1}} {{crit2=crit2}} {{description=description}} {{charname=charname}}

&{template:npcatk}

&{template:npcatk} {{attack=1}} {{damage=1}} {{dmg1flag=1}} {{name=name}} {{rname=rname}} {{rnamec=rnamec}} {{r1=r1}} {{query=1}} {{normal=1}} {{r2=r2}} {{description=description}} {{charname=charname}}

&{template:npcdmg}

&{template:npcdmg} {{damage=1}} {{dmg1flag=1}} {{dmg1=dmg1}} {{dmg1type=dmg1type}} {{dmg2=dmg2}} {{dmg2type=dmg2type}} {{crit=1}} {{crit1=crit1}} {{crit2=crit2}} {{charname=charname}}

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, and atkdmg generated 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.
• 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.