Interface D20ActorRollOptions

Hierarchy

Properties

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

Properties

Optional bonus

bonus?: string | number

An additional bonus to be added to the roll.

Optional chatMessage

chatMessage?: boolean

Whether a chat message should be created.

Default Value

true

Optional chatTemplateData

chatTemplateData?: object

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

Optional compendium

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

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

Type declaration

  • entry: string
  • type: string

Optional dice

dice?: string

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

Default Value

"1d20"

Optional flavor

flavor?: string

The flavor of the roll

Optional messageData

messageData?: object

Additional data to add to the chat message.

Optional noSound

noSound?: boolean

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

Default Value

false

Optional parts

parts?: string[]

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

Default Value

[]

Optional rollData

rollData?: object

Data object the roll is evaluated against.

Default Value

{}

Optional rollMode

rollMode?: string

The rollMode with which the chat message is created.

Default Value

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

Optional skipDialog

skipDialog?: boolean

Whether a user facing dialog should be shown.

Default Value

true

Optional speaker

speaker?: PropertiesToSource<ChatSpeakerDataProperties>

The speaker of the chat message.

Optional staticRoll

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

Optional subject

subject?: object

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc