Skip to main content

Roll

This formula allows you to instantly roll dice and returns the result immediately. No UI animations will be done for this result. If you're looking to trigger the app's dice roller and display a result, please see the Roll effect under Mechanics instead.

Returns​

integer

JSON Format​

{
  "type": "roll",
  "formula": ...
}

RPG Script​

This component can be written in RPG Script as:

roll(...)

Fields​

FieldTypeRequiredDescription
formulaStatFormulaComponent✓The formula for a dice roll formula. Dice roll formulas are strings in the form of "xdy + n" or "xdy - n", where x, y and n are numbers. The app will roll x dices of type dy (e.g: if y is 8, it'll roll x d8), add them up and then add (or subtract) n.
@type string