Heroic Lands

Function runWorldMigrations

  • runWorldMigrations(
        game: any,
        steps?: readonly MigrationStep[],
    ): Promise<MigrationSummary>

  • Run the version-keyed world migration and advance the stored version.

    Reads the world's systemMigrationVersion, resolves the effective "from" version (fresh vs. legacy — see resolveFromVersion), plans the applicable steps against the running system version, applies them across the in-scope document types, and stamps the version forward. Returns a summary for logging and tests. Purely orchestration — the caller gates on the active GM.

    Parameters

    • game: any

      The Foundry game object.

    • steps: readonly MigrationStep[] = SOHL_MIGRATIONS

      The migration registry (defaults to SOHL_MIGRATIONS; overridable in tests).

    Returns Promise<MigrationSummary>

    A summary of what was planned, applied, and stamped.

Settings

Member Visibility