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

    Interface ActorRollOptions

    interface ActorRollOptions {
        bonus?: string;
        chatMessage?: boolean;
        dc?: number;
        dice?: string;
        maneuver?:
            | null
            | boolean
            | "drag"
            | "grapple"
            | "bullRush"
            | "dirtyTrick"
            | "disarm"
            | "overrun"
            | "reposition"
            | "steal"
            | "sunder"
            | "trip";
        messageData?: object;
        noSound?: boolean;
        rollMode?: string;
        skipDialog?: boolean;
        staticRoll?: number;
        token?: TokenDocument;
    }

    Hierarchy

    • Omit<
          D20ActorRollOptions,
          | "rollData"
          | "parts"
          | "subject"
          | "flavor"
          | "chatTemplateData"
          | "compendium"
          | "speaker",
      >
      • ActorRollOptions
    Index

    Properties

    bonus?: string

    Bonus to the roll.

    chatMessage?: boolean

    Whether a chat message should be created.

    true

    dc?: number

    DC threshold

    dice?: string

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

    "1d20"

    maneuver?:
        | null
        | boolean
        | "drag"
        | "grapple"
        | "bullRush"
        | "dirtyTrick"
        | "disarm"
        | "overrun"
        | "reposition"
        | "steal"
        | "sunder"
        | "trip"
    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

    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

    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

    token?: TokenDocument

    Associated token if any.