Interface AirshipServerConfig

Configuration for an Airship server.

interface AirshipServerConfig {
    accessMode?: AccessMode;
    allowedUserIds?: string[];
    fleet?: AgonesFleet;
    gameConfig?: object;
    maxPlayers?: number;
    region?: string;
    sceneId?: string;
    tags?: string[];
}

Properties

accessMode? allowedUserIds? fleet? gameConfig? maxPlayers? region? sceneId? tags?

Properties

Optional accessMode

accessMode?: AccessMode

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

Optional allowedUserIds

allowedUserIds?: string[]

Only allow the players in this list to join the server.

Optional fleet

fleet?: AgonesFleet

The fleet the game server will use. This determines the performance characteristics of the underlying server host.

Optional gameConfig

gameConfig?: object

An object representing game configuration to be passed to the created server.

Optional maxPlayers

maxPlayers?: number

The max players setting for the server. If not set, the default for the game is used. You can change the default for your game on https://create.airship.gg

Optional region

region?: string

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

Optional sceneId

sceneId?: string

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

Optional tags

tags?: string[]

An array of tags to associate with this server. You can have up to 100 tags.

Settings

Member Visibility

Theme

On This Page

accessModeallowedUserIdsfleetgameConfigmaxPlayersregionsceneIdtags