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

    Class MacroWizard

    Hierarchy

    • HandlebarsApplication<this> & ApplicationV2<
          RenderContext,
          Configuration,
          RenderOptions,
          this,
      >
      • MacroWizard
    Index

    Constructors

    constructor

    Properties

    ACTOR_ROLL_OPTIONS DEFAULT_OPTIONS DEFAULT_TYPE DOCUMENT_DEFAULTS DOCUMENT_TYPES DROP_TYPES IMAGES MACRO_TYPES PARTS

    Accessors

    document dropData promise title

    Methods

    _generalizeScript _generateActorScript _generateDocumentScript _generateName _generateScript _getSafeString _initializeApplicationOptions _onClose _prepareContext _prepareFooterContext _prepareMainContext _preparePartContext wait

    Constructors

    • Applications are constructed by providing an object of configuration options.

      Parameters

      • Optionaloptions: {}

        Options used to configure the Application instance (default: {})

      Returns MacroWizard

    Properties

    ACTOR_ROLL_OPTIONS: { defaults: { skip: boolean } } = ...

    Available options to actor rolls

    DEFAULT_OPTIONS: {
        actions: { create: Object };
        classes: string[];
        form: { closeOnSubmit: boolean; handler: Object; submitOnChange: boolean };
        position: { height: number; width: number };
        tag: string;
        window: { icon: string; resizable: boolean; title: string };
    } = ...
    DEFAULT_TYPE: string[] = ...

    Default script type priority

    DOCUMENT_DEFAULTS: {
        Action: { base: { card: false; sheet: true; toggle: false; use: true } };
        Actor: { base: { roll: true } };
        Item: {
            base: { card: true; sheet: true; toggle: true; use: true };
            class: { toggle: false; use: false };
            race: { toggle: false; use: false };
            spell: { toggle: false };
            weapon: { toggle: false };
        };
    } = ...
    DOCUMENT_TYPES: string[] = ...

    Supported document types

    DROP_TYPES: string[] = ...

    Supported drop data types.

    IMAGES: {
        abilityScore: "systems/pf1/icons/skills/blue_35.jpg";
        "attack.cmb": "systems/pf1/icons/feats/improved-grapple.jpg";
        "attack.melee": "systems/pf1/icons/skills/weapon_23.jpg";
        "attack.ranged": "systems/pf1/icons/skills/arrow_07.jpg";
        bab: "systems/pf1/icons/skills/yellow_08.jpg";
        cl: "systems/pf1/icons/spells/wind-grasp-eerie-3.jpg";
        cmb: "systems/pf1/icons/feats/improved-grapple.jpg";
        concentration: "systems/pf1/icons/skills/light_01.jpg";
        defenses: "systems/pf1/icons/items/armor/shield-light-metal.png";
        initiative: "systems/pf1/icons/skills/weapon_41.jpg";
        save: "systems/pf1/icons/items/inventory/dice.jpg";
        skill: "systems/pf1/icons/items/inventory/dice.jpg";
    } = ...
    MACRO_TYPES: string[] = ...
    PARTS: { footer: { template: string }; main: { template: string } } = ...

    Accessors

    • get document(): Document<any, any, null>

      Returns Document<any, any, null>

    • get promise(): Promise<any>

      Returns Promise<any>

    • get title(): string

      A convenience reference to the title of the Application window.

      Returns string

    Methods

    _generalizeScript

    • _generalizeScript(script: any): void

      Parameters

      • script: any

      Returns void

    _generateActorScript

    • _generateActorScript(): string[]

      Returns string[]

    _generateDocumentScript

    • _generateDocumentScript(): string[]

      Generate either item or action script.

      Returns string[]

    _generateName

    • _generateName(): string

      Generate Default Name

      Returns string

    _generateScript

    • _generateScript(): string[]

      Generate Script Lines

      Returns string[]

    _getSafeString

    • _getSafeString(name: string): string

      Generate JS-safe string

      Attempts to produce easier to read string than JSON.stringify() would create.

      Parameters

      • name: string

      Returns string

    _initializeApplicationOptions

    • _initializeApplicationOptions(options: any): Configuration

      Initialize configuration options for the Application instance. The default behavior of this method is to intelligently merge options for each class with those of their parents.

      • Array-based options are concatenated
      • Inner objects are merged
      • Otherwise, properties in the subclass replace those defined by a parent

      Parameters

      • options: any

        Options provided directly to the constructor

      Returns Configuration

      Configured options for the application instance

    _onClose

    • _onClose(options: any): void

      Parameters

      • options: any

      Returns void

    _prepareContext

    • _prepareContext(
          options: any,
      ): {
          img: any;
          source: { document: Document<any, any, null>; type: any; uuid: string };
      }

      Parameters

      • options: any

      Returns {
          img: any;
          source: { document: Document<any, any, null>; type: any; uuid: string };
      }

    _prepareFooterContext

    • _prepareFooterContext(context: object): void

      Prepare Footer Context

      Parameters

      • context: object

      Returns void

    _prepareMainContext

    • _prepareMainContext(context: any): void

      Parameters

      • context: any

      Returns void

    _preparePartContext

    • _preparePartContext(partId: any, context: any, options: any): any

      Prepare context that is specific to only a single rendered part.

      It is recommended to augment or mutate the shared context so that downstream methods like _onRender have visibility into the data that was used for rendering. It is acceptable to return a different context object rather than mutating the shared context at the expense of this transparency.

      Parameters

      • partId: any

        The part being rendered

      • context: any

        Shared context provided by _prepareContext

      • options: any

        Options which configure application rendering behavior

      Returns any

      Context data for a specific part

    • Initialize, render, and wait for

      Parameters

      • options: object = {}

        App options

      Returns null | object

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods