Constructors

Methods

  • Realms are how a singleton world scales: one process per realm, all sharing a database. These are the site-admin views of the multiplayer realm records.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Declare how many server processes a build may run at once: singleton, replicated, pooled, serverless, or static. Re-clamps the stored replica shape and is honored by the next deployment.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • build_id: string
    • data: {
          capacity_model: string;
      }
      • capacity_model: string

    Returns AxiosPromise<default<T>>

  • Resize the Container App behind a build. Replica bounds are enforced server side against the build's capacity model, so a singleton world cannot be given a second replica. Pass acknowledge_outage when deliberately setting min replicas to 0 on a singleton or replicated deployment, which takes the game offline.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • build_id: string
    • data: object

    Returns AxiosPromise<default<T>>

  • Update the warm/spare/ceiling shape of a matchmaker managed instance pool. Rejected for any build whose capacity model is not "pooled".

    Type Parameters

    • T

    Parameters

    • title_id: string
    • build_id: string
    • data: object

    Returns AxiosPromise<default<T>>

Generated using TypeDoc