Interface D20RollChatOptions

interface D20RollChatOptions {
    chatTemplate?: string;
    chatTemplateData?: object;
    compendium?: {
        entry: string;
        type: string;
    };
    create?: boolean;
    noSound?: boolean;
    rollMode?: string;
    speaker?: PropertiesToSource<ChatSpeakerDataProperties>;
    subject?: object;
}

Properties

chatTemplate? chatTemplateData? compendium? create? noSound? rollMode? speaker? subject?

Properties

OptionalchatTemplate

chatTemplate?: string

The template used to render the chat message.

Default Value

D20RollPF.CHAT_TEMPLATE

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.

Optionalcreate

create?: boolean

Whether a chat message should be created.

Default Value

true

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")

Optionalspeaker

speaker?: PropertiesToSource<ChatSpeakerDataProperties>

The speaker of the chat message.

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