Skip to main content

Rollable

This formula allows you to create a Rollable (as in the rollable value type for stats). These type of values in the app can be used, for example, for the Roll effect (under Mechanics).

Returns​

rollable

JSON Format​

{
  "type": "rollable",
  "formulas": ...,
  "text": ...
}

RPG Script​

This component can be written in RPG Script as:

rollable(...)

Fields​

FieldTypeRequiredDescription
formulasStatFormulaComponent✓The formula for the dice formulas that should be rolled and then added together. It has to return a list of strings in the form of dice formulas (see the Roll formula type for more details on how these formulas should look like).
@type array<string>
textStatFormulaComponent✓A text to display next to the roll result. This is usually used to add contextual information to the roll. e.g: If rolling for damage, this might be used to keep track of the damage type that was rolled for.
@type string