Interface AirshipServerConfig

Configuration for an Airship server.

interface AirshipServerConfig {
    accessMode?: AirshipServerAccessMode;
    allowedUserIds?: string[];
    region?: string;
    sceneId?: string;
}

Properties

The access mode of the server. Defaults to OPEN on the default scene, and DIRECT_JOIN on any other scene.

allowedUserIds?: string[]

Only allow the players in this list to join the server. Forces accessMode to CLOSED.

region?: string

The region the game server should be started in. Defaults to the same region as the server that makes the create request.

sceneId?: string

The scene the server will start on. Defaults to the scene provided during deployment.