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

    Interface SharedActionData

    A common data object used to store and share data between stages of an action's usage.

    interface SharedActionData {
        action: ItemAction;
        attackBonus: string[];
        attacks: ActionUseAttack[];
        casterLevelCheck: boolean;
        chatAttacks: ChatAttack[];
        chatData: object;
        chatMessage: boolean;
        chatTemplate: string;
        concentrationCheck: boolean;
        conditionalPartsCommon: object;
        conditionals?: object[];
        config: object;
        damageBonus: string[];
        dice: string;
        event?: null | Event;
        fullAttack: boolean;
        item: ItemPF;
        message?: ChatMessage<"base" | ModuleSubType>;
        overrides: object;
        rollData: object;
        rollMode: string;
        scriptData: object;
        skipDialog: boolean;
        targets: Set<Token>;
        template?: MeasuredTemplateDocument;
        templateData: object;
        useMeasureTemplate: boolean;
        useOptions: UseOptions;
    }
    Index

    Properties

    action attackBonus attacks casterLevelCheck chatAttacks chatData chatMessage chatTemplate concentrationCheck conditionalPartsCommon conditionals? config damageBonus dice event? fullAttack item message? overrides rollData rollMode scriptData skipDialog targets template? templateData useMeasureTemplate useOptions

    Properties

    action: ItemAction

    The ItemAction this usage is based on.

    attackBonus: string[]

    Bonus values to be added to the attack roll formula

    attacks: ActionUseAttack[]

    Array of attacks

    casterLevelCheck: boolean

    Will caster level check be needed?

    chatAttacks: ChatAttack[]

    Array of chat attacks for this action's use

    chatData: object

    Data to be passed to ChatMessage.create, excluding content rendered using templateData and template.

    chatMessage: boolean

    Whether a chat message should be created at the end of the action's usage. Defaults to true.

    chatTemplate: string

    The template to be used for the creation of the chat message.

    concentrationCheck: boolean

    Will concentration check be needed?

    conditionalPartsCommon: object

    Common conditionals

    conditionals?: object[]

    Conditionals

    config: object

    Baseline configuration

    damageBonus: string[]

    Bonus values to be added to the damage roll formula

    dice: string

    Base Dice

    The base dice used for the action's attack rolls.

    return value of pf1.dice.D20RollPF.standardRoll

    event?: null | Event

    The event that triggered the action. Defaults to null.

    fullAttack: boolean

    Whether the action is a full attack. Defaults to true.

    true
    item: ItemPF

    The ItemPF this usage is based on.

    message?: ChatMessage<"base" | ModuleSubType>

    Chat message once it is created.

    overrides: object

    Overrides

    rollData: object

    The singular rollData object used for all rolls in the action

    rollMode: string

    The roll mode to be used for the creation of the chat message.

    Value of core.rollMode setting.

    scriptData: object

    Return data from script calls

    skipDialog: boolean

    Whether the user-facing dialog should get skipped. Defaults to false.

    targets: Set<Token>

    Targeted tokens

    template?: MeasuredTemplateDocument

    Template document.

    templateData: object

    Data used to render the chat card, passed to foundry.utils.renderTemplate.

    useMeasureTemplate: boolean

    Whether to use a measure template

    useOptions: UseOptions

    Usage options

    Settings

    Member Visibility

    On This Page

    Properties