Character Vault
Any Concept / Any System
Your System Come To Life
Roll20 for Android
Streamlined for your Tablet
Roll20 for iPad
Streamlined for your Tablet

Personal tools

Roll Templates

From Roll20 Wiki

Revision as of 05:36, 11 January 2015 by Riley D. (Talk | contribs)

Jump to: navigation, search

Roll Templates are a special facet of the Character Sheets system which provide additional layout and styling options for the dispay of roll results.


Using Roll Templates

Using a roll template is very easy. Just include a special flag in your chat message which tells Roll20 that you want to use a Roll Template, and then provide all of the data that you want to include. Here's an example that uses the "default" template (which all games have access to, regardless of the game system or character sheet you are using):

&{template:default} {{rollname=Test Attack}} {{attack=[[1d20]]}} {{damage=[[2d6]]}}

The &{template:<template_name>} is the part that tells the system to use a Roll Template, and specifies the name of the template you want to use. Then you just provide all the data for the template in the format {{<propertyname>= <value>}}. The "propertyname" that you should use depends on the template -- the Character Sheet documentation should let you know what's available, and we've provided documentation on all of the built-in templates below. "Value" can be either text or an inline roll, including macros, abilities, etc. Note that if you use a macro or ability, it must be an inline roll, not a "/roll" command.

Here's an example that uses a "%{Character|attack}" ability:

&{template:default} {{rollname=Test With Ability}} {{attack= %{Character_Name|attack} }} {{damage= #damagemacro }}

Built-In Roll Templates

The following roll templates are built-in to Roll20 and can be used in any game.


To use the default template, use "&{template:default}".

Property Expected Value
rollname The name of the roll, shown in the header of the roll listing
attack The attack roll
attackadvantage For systems that have advantage (such as 5E), the second attack roll. Will be shown next to the first attack roll.

Creating a Roll Template

If you are a Sheet Author, you can include as many roll templates as you want in your Character Sheet HTML and CSS. We'll let you know how below.

If you are a Mentor, you can create your own Roll Templates if you are using the "Custom" character sheet option with your game. Follow the instructions below.

Defining the Layout of the Roll Template

The first step in creating a Roll Template is defining the layout, including what properties you are going to make available to be filled in by player. Roll Templates are just HTML, and you have access to all the same HTML as any other part of a Character Sheet (including div and table). Here's an example of the layout of a Roll Table:

<div class='sheet-rolltemplate-test'>
		<tr><td><span class="tcat">Attack: </span>{{attack}} | {{attackadvantage}} vs AC</td></tr>
				<td><span class="tcat">Damage: </span>{{damage}} <span class="tcat">Crit: </span>{{dmgcrit}}</td>
				<td><span class="tcat">Type: </span>{{dmgtype}}</td>
			<td><span class="tcat">Effect: </span>{{atteffect}}</td>

Your template should have a div with a class of "sheet-rolltemplate-<template_name>". "template_name" is the same name that will be used in the &{template:<template_name>} portion of the command, and should not contain spaces. You can put the roll template anywhere you want in your Character Sheet's HTML, but we recommend putting it at the very end. It will automatically be "removed' from your template so it isn't shown as part of the sheet in the Character view.

After that, it's up to you to decide how to structure your roll. We recommend a table layout, but it's up to you.

Inside of the template, you have access to following:


You can include any property you'd like by using the double-curly-braces. So Template:Myproperty would output whatever (inline roll, text. etc.) is given to the template via {{myproperty=<value>}} in the roll. To create a new property, just add it to your template and give it a unique name. Again, avoid the use of spaces to ensure maximum compatibility with all helper functions.


If you do {{#<property>}} followed by {{/<property>}}, all of the parts between those two tags will only be shown if the property contains a value. This can be useful for providing several different parts to a template which may only be used some of the time. For example, the "Effect" part of a roll may only apply to spells, so if the roll doesn't provide an effect, that section will not be shown.

You can also do {{^<property>}} followed by Template:/propety to mean the opposite -- that is, only show the section if the given property does not exist.

Helper Functions

There are several helper functions dealing with rolls provided as well. You use these just like the normal Logic pattern above, but you are calling a function and providing a property. The section contained between the tags will only be shown if the function evaluates to true.

Helper Function Shows Section If
{{rollWasCrit() <rollname>}} If the provided roll contains any crits, the section will be shown. For example, Template:RollWasCrit() attack would check the "attack" property for an inline roll that has at least one critical roll.
{{rollWasFumble() <rollname>}} Same as rollWasCrit(), but checks for any fumbles (rolls of 1).
{{rollTotal() <rollname>}} Checks the total of an inline roll for the value. If they match, the section is shown. For example, Template:RollTotal() attack 10 would check the "attack" property for an inline roll that totaled 10.

Note: All helper functions will only check the first inline roll found in a property.

Important: When you "close" the section of a helper function, you must put the entire function call including all arguments. For example, Template:RollWasCrit() attack would be closed by Template:/rollWasCrit() attack.

Heres's an example roll template that would only show its Critical Damage section if the Attack roll is a crit:

		<tr><td><span class="tcat">Attack: </span>{{attack}}</td></tr>
                              <span class="tcat">Damage: </span>{{damage}} 
                              {{rollWasCrit() attack}}
                              <span class="tcat">Crit: </span>{{dmgcrit}}
                              {{/rollWasCrit() attack}}