Function migrateWorld

  • migrateWorld(options?): Promise<void>

  • Perform a system migration for the entire World, applying migrations for Actors, Items, Scenes, Tokens and Compendium packs

    Parameters

    • Optionaloptions: {
          dialog: undefined | object;
          fast: undefined | boolean;
          state: undefined | MigrationState;
          systemPacks: undefined | boolean;
          unlock: undefined | boolean;
      } = {}

      Additional options

      • dialog: undefined | object

        Progress dialog options. Set to falsy to disable the dialog.

      • fast: undefined | boolean

        Skip documents marked as migrated for current version.

      • state: undefined | MigrationState

        Migration state tracker

      • systemPacks: undefined | boolean

        Migrate system packs.

      • unlock: undefined | boolean

        If false, locked compendiums are ignored.

    Returns Promise<void>

    • A Promise which resolves once the migration is completed

Settings

Member Visibility