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

    Interface D20ActorRollOptions

    interface D20ActorRollOptions {
        action?: string;
        actions: unknown;
        bonus?: string;
        chatMessage?: boolean;
        chatTemplateData?: object;
        compendium?: { entry: string; type: string };
        dc?: number;
        dice?: string;
        flavor?: string;
        item?: Item<"base" | ModuleSubType>;
        messageData?: object;
        noSound?: boolean;
        parts?: string[];
        rollData?: object;
        rollMode?: string;
        skipDialog?: boolean;
        speaker?: any;
        staticRoll?: number;
        subject?: object;
        token?: TokenDocument;
    }

    Hierarchy

    • Pick<
          D20RollConstructorOptions,
          "flavor"
          | "bonus"
          | "staticRoll"
          | "actions"
          | "action",
      >
    • Pick<
          D20RollChatOptions,
          | "noSound"
          | "compendium"
          | "rollMode"
          | "chatTemplateData"
          | "subject"
          | "speaker",
      >
      • D20ActorRollOptions
    Index

    Properties

    action? actions bonus? chatMessage? chatTemplateData? compendium? dc? dice? flavor? item? messageData? noSound? parts? rollData? rollMode? skipDialog? speaker? staticRoll? subject? token?

    Properties

    action?: string

    The selected sub-action depending on the context.

    actions: unknown
    bonus?: string

    Bonus to the roll.

    chatMessage?: boolean

    Whether a chat message should be created.

    true

    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.

    dc?: number

    DC threshold

    dice?: string

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

    "1d20"

    flavor?: string

    The flavor of the roll

    item?: Item<"base" | ModuleSubType>

    Associated item

    messageData?: object

    Additional data to add to the chat message.

    noSound?: boolean

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

    false

    parts?: string[]

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

    []

    rollData?: object

    Data object the roll is evaluated against.

    {}

    rollMode?: string

    The rollMode with which the chat message is created.

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

    skipDialog?: boolean

    Whether a user facing dialog should be shown.

    true

    speaker?: any

    The speaker of the chat message.

    staticRoll?: number

    A number used as a static roll result of the d20. If null, the d20 is rolled normally and the result is used.

    undefined

    subject?: object

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

    token?: TokenDocument

    Associated token if any.

    Settings

    Member Visibility

    On This Page

    Properties