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

Personal tools

Difference between revisions of "Inline Rolls"

From Roll20 Wiki

Jump to: navigation, search
m (Inline Rolls)
(add 2 gifs, 2 imgs, formatting)
Line 1: Line 1:
 
''Main Page:'' '''[[Complete Guide to Macros & Rolls#Inline Rolls]]'''
 
''Main Page:'' '''[[Complete Guide to Macros & Rolls#Inline Rolls]]'''
[[File:Roll template default example2.JPG|left|thumb|300px|The output of a '''default template''' that shows an '''inline roll'''(yellow box) ]]'''Inline Rolls''' refers to the numerical roll result in(usually yellow) boxes that is displayed in the {{Text Chat}}, and the double bracket syntax <code><nowiki>[[2d6+2]]</nowiki></code> used for creating them. They can be used both in user-made [[macros]](Free) as well as [[API Scripts]]({{Pro}} feature).
+
[[File:Roll template default example2.JPG|right|thumb|300px|The output of a '''default template''' that shows an '''inline roll'''(yellow box) ]]
{{NavMacroDocs}}
+
__TOC__
+
 
<br>
 
<br>
 +
'''Inline Rolls''' refers to the numerical roll result in(usually yellow) boxes that is displayed in the {{Text Chat}}, and the double bracket syntax <code><nowiki>[[2d6+2]]</nowiki></code> used for creating them. They can be used both in user-made [[macros]](Free) as well as [[API Scripts]]({{Pro}} feature).
 +
<br clear=left>
 +
__TOC__
 +
<br clear=right>
 +
{{NavMacroDocs}}
 
==Inline Rolls==
 
==Inline Rolls==
 
If you use simple roll commands/macros like <code>/roll 2d10+5</code>, the whole command is a dice roll, and the individual rolled dice & their results are displayed in the {{Text Chat}}.
 
If you use simple roll commands/macros like <code>/roll 2d10+5</code>, the whole command is a dice roll, and the individual rolled dice & their results are displayed in the {{Text Chat}}.
  
But when you use [[Roll Templates]], or want to have embedded dice rolls within other commands like <code>/em</code>, you use '''inline rolls''', which results are displayed as a final sum(breakdown can be seen if you hover mouse over it). '''Inline Rolls''' are wrapped in double brackets(<code><nowiki>[[ ]]</nowiki></code>) around the calculation for it to be processed.
+
[[File:Deftemplate-roll-hover-result.gif|left|thumbnail|2300px|hovering over the result will show the breakdown of what went into the roll, and it's formula. See Ex.3 for the macro.]]
  
The result of "Normal" dice rolls is shown as individual dice images displaying the result on each dice separately, along with the total result, while inline roll results are displayed in as a single numerical result, where you can see the roll breakdown by hovering your mouse over the result.  
+
<br>But when you use [[Roll Templates]], or want to have embedded dice rolls within other commands like <code>/em</code>, you use '''inline rolls''', which results are displayed as just a final sum(the yellow box in the example). '''Inline Rolls''' are wrapped in double brackets(<code><nowiki>[[ ]]</nowiki></code>) around the calculation for it to be processed.
 +
 
 +
 
 +
The result of "Normal" dice rolls is shown as individual dice images displaying the result on each dice separately, along with the total result, while inline roll results are displayed in as a single numerical result, where you can see the roll breakdown by hovering your mouse over the result.<br clear=left>
  
 
Inline rolls are just like regular rolls, with the following exceptions:
 
Inline rolls are just like regular rolls, with the following exceptions:
Line 28: Line 34:
  
 
===Examples===
 
===Examples===
<pre>
+
[[File:Inlineroll-ex-em.gif|right|frame]]
 +
<pre style="overflow:auto;white-space:pre-wrap;">
 
/em swings their sword and does [[2d6+2]] damage.
 
/em swings their sword and does [[2d6+2]] damage.
 
</pre>
 
</pre>
<pre>
+
<pre style="overflow:auto;white-space:pre-wrap;">
 
&{template:default} {{name=Test Attack}} {{attack=[[1d20+5]]}}
 
&{template:default} {{name=Test Attack}} {{attack=[[1d20+5]]}}
 
</pre>
 
</pre>
<pre style="overflow:hidden;white-space:pre-wrap">
+
<br clear=right>
 +
<pre style="overflow:auto;white-space:pre-wrap">
 
&{template:default} {{name=Mage Bolt}} {{attack=[[1d20+3[int]+2[proficiency] ]]}} {{Damage= [[3d6[base dmg]+3[int mod]+1d8[Elder Wand bonus] force dmg]]}} {{DC [[14]] Will Save= The enemy must make the save, or take an extra [[1d8]] fire dmg. }}
 
&{template:default} {{name=Mage Bolt}} {{attack=[[1d20+3[int]+2[proficiency] ]]}} {{Damage= [[3d6[base dmg]+3[int mod]+1d8[Elder Wand bonus] force dmg]]}} {{DC [[14]] Will Save= The enemy must make the save, or take an extra [[1d8]] fire dmg. }}
 
</pre>
 
</pre>
  
 
==Inline Labels==
 
==Inline Labels==
If you want to include additional comments before the end of the roll (we call them "inline labels"), use square brackets. For example, <code>/roll 2d10+5[Fire Damage] + 3d6[Ice Damage]</code>. Inline labels works both with "normal" rolls and '''inline rolls'''.  
+
If you want to include description or explanations to what individual dice or modifiers represent in you rolls, you can introduce '''inline labels''', by using use square brackets in the macro. For example, <code>/roll 2d10+5[Fire Damage] + 3d6[Ice Damage]</code>. Inline labels works both with "normal" rolls and '''inline rolls'''. See the earlier gifs for inline label examples in inline rolls.[[File:Inline-label-example.png|right|normal roll with inline labels]]
  
 
When these comments are applied directly after a die roll they show up as tool-tips on the dice:
 
When these comments are applied directly after a die roll they show up as tool-tips on the dice:
Line 47: Line 55:
  
 
This is especially useful if a roll contains multiple variables and you want to look up what number comes from what attribute.
 
This is especially useful if a roll contains multiple variables and you want to look up what number comes from what attribute.
 +
 +
[[File:Inline-label-inline-roll.png|thumbnail|center|400px|Example of inline label use in a roll template, from the [[Mythic D6]] sheet.]]
 +
  
 
'''You can even use sheet attributes in labels.''' Especially useful if the name of the stat can be customized by the user, so the corresponding label should change to reflect the name.
 
'''You can even use sheet attributes in labels.''' Especially useful if the name of the stat can be customized by the user, so the corresponding label should change to reflect the name.
 
{{ex}}
 
{{ex}}
<pre>
+
<pre style="overflow:auto;white-space:pre-wrap;">
 
/r @{selected|customskill1}d6[@{selected|customskill1name}] + @{selected|str}[str]
 
/r @{selected|customskill1}d6[@{selected|customskill1name}] + @{selected|str}[str]
 
</pre>
 
</pre>

Revision as of 11:13, 26 May 2021

Main Page: Complete Guide to Macros & Rolls#Inline Rolls

The output of a default template that shows an inline roll(yellow box)


Inline Rolls refers to the numerical roll result in(usually yellow) boxes that is displayed in the q Text Chat, and the double bracket syntax [[2d6+2]] used for creating them. They can be used both in user-made macros(Free) as well as API Scripts(
Pro
info feature).


Contents


Macro Creation

Advanced

Misc.

Inline Rolls

If you use simple roll commands/macros like /roll 2d10+5, the whole command is a dice roll, and the individual rolled dice & their results are displayed in the q Text Chat.

hovering over the result will show the breakdown of what went into the roll, and it's formula. See Ex.3 for the macro.


But when you use Roll Templates, or want to have embedded dice rolls within other commands like /em, you use inline rolls, which results are displayed as just a final sum(the yellow box in the example). Inline Rolls are wrapped in double brackets([[ ]]) around the calculation for it to be processed.


The result of "Normal" dice rolls is shown as individual dice images displaying the result on each dice separately, along with the total result, while inline roll results are displayed in as a single numerical result, where you can see the roll breakdown by hovering your mouse over the result.

Inline rolls are just like regular rolls, with the following exceptions:

  • You can use them in any chat message, not just a roll. For example, you can do a regular chat message, an emote(/em), or a whisper(/w), with an inline roll included.
    • Ex. /w alice the silent curse will affect you for [[2d4]] days.
  • They are evaluated completely before any (/roll) commands, so you can use them as "random variables" in your rolls. See Order of Operations for more.
  • You see only the total roll result by default, by the dice roll breakdown can be seen if you hover your mouse over the result.
    • Using inline labels in rolls will make it easier to understand more complex rolls
  • Highlights (Critical Successes & Failures) are highlighted
    • If an inline roll contains a critical success, it will be highlighted with a green border.
    • If there's a critical failure, it's highlighted in red.
    • If it contains both, it's in blue.

Also when you mouse-over the inline roll to see the details of the roll, it'll show red and green highlights for the individual dice that rolled crits/fumbles.

With inline rolls, the numerical end result is shown in a (yellow) box, and if you hover you mouse over the result, you see the full equation of the roll, along with the result of each.

Examples

Inlineroll-ex-em.gif
/em swings their sword and does [[2d6+2]] damage.
&{template:default} {{name=Test Attack}} {{attack=[[1d20+5]]}}


&{template:default} {{name=Mage Bolt}} {{attack=[[1d20+3[int]+2[proficiency] ]]}} {{Damage= [[3d6[base dmg]+3[int mod]+1d8[Elder Wand bonus] force dmg]]}} {{DC [[14]] Will Save= The enemy must make the save, or take an extra [[1d8]] fire dmg. }}

Inline Labels

If you want to include description or explanations to what individual dice or modifiers represent in you rolls, you can introduce inline labels, by using use square brackets in the macro. For example, /roll 2d10+5[Fire Damage] + 3d6[Ice Damage]. Inline labels works both with "normal" rolls and inline rolls. See the earlier gifs for inline label examples in inline rolls.
normal roll with inline labels

When these comments are applied directly after a die roll they show up as tool-tips on the dice:

/roll 2d10+5[Fire Damage] + 3d6[Ice Damage]

This is especially useful if a roll contains multiple variables and you want to look up what number comes from what attribute.

Example of inline label use in a roll template, from the Mythic D6 sheet.


You can even use sheet attributes in labels. Especially useful if the name of the stat can be customized by the user, so the corresponding label should change to reflect the name.
Example:

/r @{selected|customskill1}d6[@{selected|customskill1name}] + @{selected|str}[str]

Tricks

Related Pages