Pathfinder 1e for Foundry VTT
    Preparing search index...

    Interface D20RollChatOptions

    interface D20RollChatOptions {
        chatTemplate?: string;
        chatTemplateData?: object;
        compendium?: { entry: string; type: string };
        create?: boolean;
        noSound?: boolean;
        notes?: Record<string, { source?: string; text: string }[]>;
        properties?: {
            header: string;
            id: string;
            value?: { source?: string; text: string }[];
        }[];
        rollMode?: string;
        speaker?: { alias?: string };
        subject?: object;
    }
    Index

    Properties

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

    Properties

    chatTemplate?: string

    The template used to render the chat message.

    D20RollPF.CHAT_TEMPLATE

    chatTemplateData?: object

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

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

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

    create?: boolean

    Whether a chat message should be created.

    true

    noSound?: boolean

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

    false

    notes?: Record<string, { source?: string; text: string }[]>

    List of notes to display along the chat card.

    properties?: {
        header: string;
        id: string;
        value?: { source?: string; text: string }[];
    }[]

    Array of properties to later be added on chat card notes

    rollMode?: string

    The rollMode with which the chat message is created.

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

    speaker?: { alias?: string }

    The speaker of the chat message.

    https://foundryvtt.com/api/interfaces/foundry.documents.types.ChatSpeakerData.html

    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