Interface AirshipGameTransferConfig

Configuration for Airship transfers to games.

interface AirshipGameTransferConfig {
    clientTransferData?: unknown;
    preferredServerId?: string;
    sceneId?: string;
    serverTransferData?: unknown;
}

Properties

clientTransferData? preferredServerId? sceneId? serverTransferData?

Properties

Optional clientTransferData

clientTransferData?: unknown

JSON encodable object that will be provided to the client on transfer

Optional preferredServerId

preferredServerId?: string

The preferred server to transfer to. If transfering to this server is not possible or it does not match the other requested parameters, a different server will be selected.

Optional sceneId

sceneId?: string

The sceneId to transfer the player to. Note that this is based on the scene the server was started with, not it's currently active scene. If no servers are available, a new server with this starting scene will be created.

This parameter is ignored if the gameId being transfered to does not match the calling server gameId.

Optional serverTransferData

serverTransferData?: unknown

JSON encodable object that will be provided to the server being joined

Settings

Member Visibility

Theme

On This Page

clientTransferDatapreferredServerIdsceneIdserverTransferData