Interface ChatOptions

Options accepted by SohlSpeaker.toChat for a chat message.

interface ChatOptions {
    flavor: string;
    rollMode: string;
    rolls: sohl.entity.roll.SimpleRoll[];
    sound: string;
    style: SohlSpeakerStyle;
    user: string;
}

Index

Properties

flavor rollMode rolls sound style user

Properties

flavor

flavor: string

Message flavor text.

rollMode

rollMode: string

Visibility mode for this message (Foundry roll mode, e.g. "gmroll" to whisper to GMs). Overrides the speaker's default when set.

rolls

rolls: sohl.entity.roll.SimpleRoll[]

Rolls to attach to the message.

sound

sound: string

Sound to play when the message posts.

style

style: SohlSpeakerStyle

Chat-card style (whisper, roll, OOC, etc.).

user

user: string

Id of the user the message is posted as.