Class AirshipServerManagerController

Allows access to game server information.

Index

Methods

GetBestRegions GetFriendServers GetServerList

Methods

GetBestRegions

GetBestRegions(): Promise<{
    orderedRegionIds: string[];
    regionLatencies: {
        [regionId: string]: number;
    };
}>
Gets the best regions for the local client. Only valid regions will be returned, meaning the ordered array and values may be empty if the player could not reach the ping servers.

Returns Promise<{
    orderedRegionIds: string[];
    regionLatencies: {
        [regionId: string]: number;
    };
}>
The "orderedRegionIds" field is the regionIds ordered by lowest ping first. The "regionLatencies" field is a map of regionId to ping value.

GetFriendServers

GetFriendServers(): Promise<{
entries: AirshipServerWithFriends[];
}>
Gets servers friends of this user are on. Only listed servers are returned.

Returns Promise<{
entries: AirshipServerWithFriends[];
}>

GetServerList

GetServerList(page?): Promise<{
entries: PublicServerData[];
}>
Gets a page of the server list.
Parameters
- page: number = 0
  The page to retrieve. Starts at 0.
Returns Promise<{
entries: PublicServerData[];
}>