Class MacroWizard

constructor

• new MacroWizard(options: any): MacroWizard

  Parameters

  • options: any

  Returns MacroWizard

StaticACTOR_ROLL_OPTIONS

StaticDEFAULT_OPTIONS

StaticDEFAULT_TYPE

StaticDOCUMENT_DEFAULTS

StaticDOCUMENT_TYPES

StaticDROP_TYPES

StaticIMAGES

StaticMACRO_TYPES

StaticPARTS

document

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

  Returns Document<any, any, null>

dropData

• get dropData(): MacroDropData

  Drag & Drop Event Data

  Returns MacroDropData

promise

• get promise(): Promise<any>

  Returns Promise<any>

title

• get title(): string

  A convenience reference to the title of the Application window.

  Returns string

_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

Staticwait

• wait(options?: object): null | object

  Initialize, render, and wait for

  Parameters

  • options: object = {}

    App options

  Returns null | object