Interface IDiceRoll

Used to call the dddice API

interface IDiceRoll {
    type: string;
    theme?: string;
    label?: string;
    uuid?: string;
    is_hidden?: boolean;
    is_dropped?: boolean;
    is_cleared?: boolean;
    meta?: object;
    value?: number;
    value_to_display?: string | number | IRollValueImage;
}

Properties

type theme? label? uuid? is_hidden? is_dropped? is_cleared? meta? value? value_to_display?

Properties

type

type: string

Die type to roll

Optional theme

theme?: string

Theme slug to roll

Optional label

label?: string

A human-readable label for this die in the roll to distinguish it from others. Ex slashing vs fire damage

Optional uuid

uuid?: string

If updating the dice roll, UUID is required

Optional is_hidden

is_hidden?: boolean

If this is a hidden roll

Optional is_dropped

is_dropped?: boolean

If the dice is dropped (not calculated in the final value)

Optional is_cleared

is_cleared?: boolean

If the dice is cleared from the table (not seen by other players)

Optional meta

meta?: object

Optional data that is not critical to the functionality of a die roll but could be useful to store for display or informational purposes

Optional value

value?: number

Optional value to set for a die roll. Useful if using an external RNG.

Optional value_to_display

value_to_display?: string | number | IRollValueImage

Optional value to show to the user when the dice is rolled. Useful when rolling a d10x where value would range from 1-10 and value to display range from 0 to 90

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc