Interface ActorRollOptions

interface ActorRollOptions {
    bonus?: string | number;
    chatMessage?: boolean;
    dice?: string;
    messageData?: object;
    noSound?: boolean;
    rollMode?: string;
    skipDialog?: boolean;
    staticRoll?: null | number;
}

Hierarchy

  • Omit<D20ActorRollOptions,
        | "rollData"
        | "parts"
        | "subject"
        | "flavor"
        | "chatTemplateData"
        | "compendium"
        | "speaker">
    • ActorRollOptions

Properties

bonus? chatMessage? dice? messageData? noSound? rollMode? skipDialog? staticRoll?

Properties

Optionalbonus

bonus?: string | number

An additional bonus to be added to the roll.

OptionalchatMessage

chatMessage?: boolean

Whether a chat message should be created.

Default Value

true

Optionaldice

dice?: string

The roll's d20 die (replacement), or the static result the d20 should have.

Default Value

"1d20"

OptionalmessageData

messageData?: object

Additional data to add to the chat message.

OptionalnoSound

noSound?: boolean

Whether no dice sound should be played when the chat message is created.

Default Value

false

OptionalrollMode

rollMode?: string

The rollMode with which the chat message is created.

Default Value

game.settings.get("core", "rollMode")

OptionalskipDialog

skipDialog?: boolean

Whether a user facing dialog should be shown.

Default Value

true

OptionalstaticRoll

staticRoll?: null | number

A number used as a static roll result of the d20. If null, the d20 is rolled normally and the result is used.

Default Value

null

Settings

Member Visibility

On This Page

Properties