@vttforge/core / PostRollOptions

Interface: PostRollOptions

Properties

actor?

readonly optional actor?: object

The actor speaking. Ignored when speaker is given.

---

crit?

readonly optional crit?: RollThreshold

When the roll is a critical. true means the first die shows its highest face; a number means the natural result is at least that; a function decides for itself. Left out, no roll is a critical.

---

flags?

readonly optional flags?: Record<string, unknown>

Extra flags for the message, merged before the outcome is added.

---

flavor?

readonly optional flavor?: string

Text shown in the message header, above the card.

---

fumble?

readonly optional fumble?: RollThreshold

When the roll is a fumble. true means the first die shows a 1; a number means the natural result is at most that; a function decides for itself. Left out, no roll is a fumble.

---

labels?

readonly optional labels?: object

The words on the card for each outcome, as localization keys or plain text. Defaults: 'Critical' and 'Fumble'.

crit?

readonly optional crit?: string

fumble?

readonly optional fumble?: string

---

messageMode?

readonly optional messageMode?: string

A key of CONFIG.ChatMessage.modes: public, gm, blind, self or ic. Left out, the user's chat setting applies.

---

scope?

readonly optional scope?: string

The flag scope the outcome is stored under: your system or module id. Default: game.system.id.

---

speaker?

readonly optional speaker?: object

A ready speaker, as ChatMessage.getSpeaker() returns it.