Function migrateWorld

  • migrateWorld(
        options?: {
            dialog?: object;
            fast?: boolean;
            state?: MigrationState;
            systemPacks?: boolean;
            unlock?: boolean;
        },
    ): Promise<void>

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

    Parameters

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

      Additional options

      • Optionaldialog?: object

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

      • Optionalfast?: boolean

        Skip documents marked as migrated for current version.

      • Optionalstate?: MigrationState

        Migration state tracker

      • OptionalsystemPacks?: boolean

        Migrate system packs.

      • Optionalunlock?: boolean

        If false, locked compendiums are ignored.

    Returns Promise<void>

    • A Promise which resolves once the migration is completed

Settings

Member Visibility