roll.result: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Error in the code example of a custom tooltip. The [t:] parameter needs to come before the ":".)
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
===Examples===
===Examples===
====Example Mimicking the Default Display====
====Example Mimicking the Default Display====
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h:AtkBonus=6]
[h:AtkBonus=6]
[h:AbilBonus=4]
[h:AbilBonus=4]
Attack Result: [t(roll.result): 1d20+AtkBonus+AbilBonus]
Attack Result: [t(roll.result): 1d20+AtkBonus+AbilBonus]
</source>
</syntaxhighlight>


[[Image:Tooltip-rollresult-example.jpg|frame|right]]
[[Image:Tooltip-rollresult-example.jpg|frame|right]]
Line 17: Line 17:
To illustrate how the order of evaluation can be useful, consider the following short example:
To illustrate how the order of evaluation can be useful, consider the following short example:


<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[t( if(roll.result > 10, "Hit", "Miss") ): d20]
[t( if(roll.result > 10, "Hit", "Miss") ): d20]
</source>
</syntaxhighlight>
This example will display {{code|Hit}} or {{code|Miss}} depending on the result of the d20 roll, and the tooltip when hovering over either word will be the actual numeric result of the d20 roll.
This example will display {{code|Hit}} or {{code|Miss}} depending on the result of the d20 roll, and the tooltip when hovering over either word will be the actual numeric result of the d20 roll.


Line 26: Line 26:


[[Category:Special Variable]]
[[Category:Special Variable]]
[[Category:Macro Function]]

Latest revision as of 20:03, 4 July 2023

The special variable roll.result is used within the parameter of the [tooltip:] roll option.

Examples

Example Mimicking the Default Display

[h:AtkBonus=6]
[h:AbilBonus=4]
Attack Result: [t(roll.result): 1d20+AtkBonus+AbilBonus]

Evaluates 1d20+AtkBonus+AbilBonus, assigns that value to roll.result, and then displays the final result with a tooltip containing the value of roll.result.

The parameter for the [tooltip:] roll option is evaluated after the roll itself is evaluated, so that roll.result is available for display.

Example of a Custom Tooltip Based on the roll.result

To illustrate how the order of evaluation can be useful, consider the following short example:

[t( if(roll.result > 10, "Hit", "Miss") ): d20]

This example will display Hit or Miss depending on the result of the d20 roll, and the tooltip when hovering over either word will be the actual numeric result of the d20 roll.

See Also

[tooltip:]