Interface D20ActorRollOptions

interface D20ActorRollOptions {
    bonus?: string | number;
    chatMessage?: boolean;
    chatTemplateData?: object;
    compendium?: {
        entry: string;
        type: string;
    };
    dice?: string;
    flavor?: string;
    messageData?: object;
    noSound?: boolean;
    parts?: string[];
    rollData?: object;
    rollMode?: string;
    skipDialog?: boolean;
    speaker?: PropertiesToSource<ChatSpeakerDataProperties>;
    staticRoll?: null | number;
    subject?: object;
}

Hierarchy

  • Pick<D20RollConstructorOptions, "flavor" | "bonus" | "staticRoll">
  • Pick<D20RollChatOptions,
        | "noSound"
        | "compendium"
        | "rollMode"
        | "chatTemplateData"
        | "subject"
        | "speaker">
    • D20ActorRollOptions

Properties

bonus? chatMessage? chatTemplateData? compendium? dice? flavor? messageData? noSound? parts? rollData? rollMode? skipDialog? speaker? staticRoll? subject?

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

OptionalchatTemplateData

chatTemplateData?: object

Additional data passed to the chat message's content's renderTemplate.

Optionalcompendium

compendium?: {
    entry: string;
    type: string;
}

Data used to create a link to a compendium entry in the chat message.

Optionaldice

dice?: string

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

Default Value

"1d20"

Optionalflavor

flavor?: string

The flavor of the roll

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

Optionalparts

parts?: string[]

An array of strings from which the roll's formula is created.

Default Value

[]

OptionalrollData

rollData?: object

Data object the roll is evaluated against.

Default Value

{}

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

Optionalspeaker

speaker?: PropertiesToSource<ChatSpeakerDataProperties>

The speaker of the chat message.

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

Optionalsubject

subject?: object

Data stored in the chat message's flags to allow for easier identification of the message's subject.

Settings

Member Visibility

On This Page

Properties