Class default

Hierarchy

Host<IMultiplayerEvents>
- default

Index

Constructors

constructor

new default(): default
Returns default
Overrides EventEmitter.Host<IMultiplayerEvents>.constructor
- Defined in src/game/multiplayer/Multiplayer.ts:187

Properties

`Readonly` event

event: IEventEmitter<default, IMultiplayerEvents>

Accessors

areSyncChecksSuppressed

get areSyncChecksSuppressed(): boolean
Returns boolean
- Defined in src/game/multiplayer/Multiplayer.ts:326

isClient

get isClient(): boolean
Returns boolean
- Defined in src/game/multiplayer/Multiplayer.ts:322

isConnected

get isConnected(): boolean
Returns boolean
- Defined in src/game/multiplayer/Multiplayer.ts:306

isPacketProcessingPaused

get isPacketProcessingPaused(): boolean
Returns boolean
- Defined in src/game/multiplayer/Multiplayer.ts:310

isProcessingPacket

get isProcessingPacket(): boolean
Returns boolean
- Defined in src/game/multiplayer/Multiplayer.ts:314

isServer

get isServer(): boolean
Returns boolean
- Defined in src/game/multiplayer/Multiplayer.ts:318

options

get options(): ImmutableObject<IMultiplayerOptions>
Returns ImmutableObject<IMultiplayerOptions>
- Defined in src/game/multiplayer/Multiplayer.ts:342

Methods

addAfterSyncChecks

addAfterSyncChecks(packet: IPacket<any>): void
Parameters
- packet: IPacket<any>
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1761

addBeforeSyncChecks

addBeforeSyncChecks(packet: IPacket<any>): void
Parameters
- packet: IPacket<any>
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1749

addSyncCheck

addSyncCheck(syncCheck: MultiplayerSyncCheck, value: any, addStackTrace?: boolean): void
Parameters
- syncCheck: MultiplayerSyncCheck
- value: any
- addStackTrace: boolean = false
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1720

addSyncCheckWithSeed

addSyncCheckWithSeed(island: default, syncCheck: MultiplayerSyncCheck, ...messages: any[]): void
Parameters
- island: default
- syncCheck: MultiplayerSyncCheck
- Rest ...messages: any[]
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1745

checkConnection

checkConnection(): Promise<void>
Returns Promise<void>
- Defined in src/game/multiplayer/Multiplayer.ts:1683

clearSteamNetworkConnectionWebRTCFallbackTimer

clearSteamNetworkConnectionWebRTCFallbackTimer(): void
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1868

closeConnection

closeConnection(reason: DisconnectReason, connection: IConnection): boolean
Parameters
- reason: DisconnectReason
- connection: IConnection
Returns boolean
- Defined in src/game/multiplayer/Multiplayer.ts:1044

convertGameCodeToServerInfo

convertGameCodeToServerInfo(gameCode: string): ServerInfo
Parameters
- gameCode: string
Returns ServerInfo
- Defined in src/game/multiplayer/Multiplayer.ts:504

createOrExtendSteamNetworkConnectionWebRTCFallbackTimer

createOrExtendSteamNetworkConnectionWebRTCFallbackTimer(timeoutTime: number): void
Parameters
- timeoutTime: number
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1859

createServer

createServer(serverInfo: ServerInfo): void
Parameters
- serverInfo: ServerInfo
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:546

disconnect

disconnect(reason: DisconnectReason, args?: any[], unloadingOrResetGameState?: boolean): Promise<boolean>
Disconnects from multiplayer Callable from a server or client If a client is in a game, disconnectAndResetGameState should be called

Returns
True when it disconnected. False is there was nothing to disconnect
Parameters
- reason: DisconnectReason
- args: any[] = []
- unloadingOrResetGameState: boolean = false
Returns Promise<boolean>
- Defined in src/game/multiplayer/Multiplayer.ts:724

disconnectAndResetGameState

disconnectAndResetGameState(reason: UnableToJoinGame, unableToJoinReason: UnableToJoinReason): Promise<void>
Parameters
- reason: UnableToJoinGame
- unableToJoinReason: UnableToJoinReason
Returns Promise<void>
- Defined in src/game/multiplayer/Multiplayer.ts:907
disconnectAndResetGameState(reason: DisconnectReason, reasonDescription?: any[]): Promise<void>
Parameters
- reason: DisconnectReason
- Optional reasonDescription: any[]
Returns Promise<void>
- Defined in src/game/multiplayer/Multiplayer.ts:908

displayJoinServerRetryDialog

displayJoinServerRetryDialog(matchmakingInfo: IMatchmakingInfo, retryReason: JoinServerRetryReason): Promise<void>
Parameters
- matchmakingInfo: IMatchmakingInfo
- retryReason: JoinServerRetryReason
Returns Promise<void>
- Defined in src/game/multiplayer/Multiplayer.ts:883

enableSteamNetworkConnections

enableSteamNetworkConnections(enable: boolean): void
Parameters
- enable: boolean
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:451

executeClientside

executeClientside(lambda: (() => any)): void
Executes a function while ensuring it is runs outside the context of any executing actions/multiplayer logic in order to prevent desyncs
Parameters
- lambda: (() => any)
  
  Function to execute
  - - (): any
    - Returns any
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1198

getBannedPlayers

getBannedPlayers(): string[]
Returns string[]
- Defined in src/game/multiplayer/Multiplayer.ts:525

getClients

getClients(): IConnection[]
Returns IConnection[]
- Defined in src/game/multiplayer/Multiplayer.ts:1036

getConnectedGameCode

getConnectedGameCode(): undefined | string
Three types of game codes:
1. Dedicated server code - ex. 1.2.3.4:1234
2. Steam lobby code - ex. steam:109775241017071190
3. Global matchmaking server id - ex. 87287724-49aa-e556-4145-3ed96c649a20
Returns undefined | string
- Defined in src/game/multiplayer/Multiplayer.ts:466

getConnectedMatchmakingInfo

getConnectedMatchmakingInfo(): undefined | IMatchmakingInfo
Returns undefined | IMatchmakingInfo
- Defined in src/game/multiplayer/Multiplayer.ts:456

getDedicatedServerMatchmakingInfo

getDedicatedServerMatchmakingInfo(matchmakingServer: string, identifier?: string): IMatchmakingInfo
Parameters
- matchmakingServer: string
- identifier: string = ...
Returns IMatchmakingInfo
- Defined in src/game/multiplayer/Multiplayer.ts:516

getPlayerIdentifier

getPlayerIdentifier(): string
Returns string
- Defined in src/game/multiplayer/Multiplayer.ts:330

getServerMods

getServerMods(): IServerMod[]
Returns IServerMod[]
- Defined in src/game/multiplayer/Multiplayer.ts:1601

isKeepAliveTimeoutPaused

isKeepAliveTimeoutPaused(): boolean
Returns boolean
- Defined in src/game/multiplayer/Multiplayer.ts:1543

isSteamLobby

isSteamLobby(gameCode: string): boolean
Parameters
- gameCode: string
Returns boolean
- Defined in src/game/multiplayer/Multiplayer.ts:500

isSyncCheckEnabled

isSyncCheckEnabled(syncCheck: MultiplayerSyncCheck): boolean
Checks if a sync check is active and enabled. Active means there's a current sync check being recorded
Parameters
- syncCheck: MultiplayerSyncCheck
Returns boolean
- Defined in src/game/multiplayer/Multiplayer.ts:1711

joinServer

joinServer(serverInfo: ServerInfo, options?: Partial<IJoinServerOptions>): Promise<void>
Parameters
- serverInfo: ServerInfo
- Optional options: Partial<IJoinServerOptions>
Returns Promise<void>
- Defined in src/game/multiplayer/Multiplayer.ts:632

kick

kick(player: default, reason: Banned | Kick): void
Parameters
- player: default
- reason: Banned | Kick
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:944

markCurrentProcessingPacket

markCurrentProcessingPacket(packetId: number, processing: boolean): void
Parameters
- packetId: number
- processing: boolean
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1336

onLobbyEntered

onLobbyEntered(success: boolean, lobbyId: string): void
Parameters
- success: boolean
- lobbyId: string
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:984

onLobbyExited

onLobbyExited(lobbyId: string): void
Parameters
- lobbyId: string
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1030

onPlaying

onPlaying(): Promise<void>
Returns Promise<void>
- Defined in src/game/multiplayer/Multiplayer.ts:961

pauseKeepAliveTimeouts

pauseKeepAliveTimeouts(): void
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1547

processDesyncPacket

processDesyncPacket(connection: IConnection, desyncPacket: default): void
Parameters
- connection: IConnection
- desyncPacket: default
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:2770

rejoinServer

rejoinServer(options?: {
    automaticallyRetry?: boolean;
    enableSteamNetworkConnections?: boolean;
    randomizeIdentifier?: boolean;
}): Promise<boolean>
Parameters
- Optional options: {
      automaticallyRetry?: boolean;
      enableSteamNetworkConnections?: boolean;
      randomizeIdentifier?: boolean;
  }
  - Optional automaticallyRetry?: boolean
  - Optional enableSteamNetworkConnections?: boolean
  - Optional randomizeIdentifier?: boolean
Returns Promise<boolean>
- Defined in src/game/multiplayer/Multiplayer.ts:696

removePlayer

removePlayer(connection: IConnection, reason: DisconnectReason): void
Parameters
- connection: IConnection
- reason: DisconnectReason
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1130

removePlayers

removePlayers(reason: DisconnectReason): void
Parameters
- reason: DisconnectReason
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1124

resolveSyncPacketWaiting

resolveSyncPacketWaiting(packet: IPacket<any>, wait: number): void
Parameters
- packet: IPacket<any>
- wait: number
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1351

resolveSyncPacketsWaiting

resolveSyncPacketsWaiting(waitId?: string, value?: unknown): void
Parameters
- Optional waitId: string
- Optional value: unknown
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1378

resumeKeepAliveTimeouts

resumeKeepAliveTimeouts(): void
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1574

runSafely

runSafely<T>(executor: (() => Promise<T>), options: IMultiplayerRunSafelyOptions): Promise<T>
Execute an async function while applying some temporary state changes
Type Parameters
- T = void
Parameters
- executor: (() => Promise<T>)
  - - (): Promise<T>
    - Returns Promise<T>
- options: IMultiplayerRunSafelyOptions
Returns Promise<T>
- Defined in src/game/multiplayer/Multiplayer.ts:1427

sendChatMessage

sendChatMessage(sender: default, message: string): Promise<void>
Parameters
- sender: default
- message: string
Returns Promise<void>
- Defined in src/game/multiplayer/Multiplayer.ts:1773

sendConnectPacket

sendConnectPacket(): void
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1097

sendPacket

sendPacket(packet: IPacket<any>, exclude?: PacketTarget): void
Parameters
- packet: IPacket<any>
- Optional exclude: PacketTarget
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1151

sendPacketTo

sendPacketTo(to: PacketTarget, packet: IPacket<any>, force?: boolean): void
Parameters
- to: PacketTarget
- packet: IPacket<any>
- Optional force: boolean
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1175

setBanned

setBanned(identifier: string, ban: boolean): boolean
Parameters
- identifier: string
- ban: boolean
Returns boolean
- Defined in src/game/multiplayer/Multiplayer.ts:529

setOptions

setOptions(options: IMultiplayerOptions, updateGame?: boolean): void
Parameters
- options: IMultiplayerOptions
- updateGame: boolean = false
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:346

setPlayerIdentifier

setPlayerIdentifier(identifier: string): void
Parameters
- identifier: string
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:334

suppressSyncChecks

suppressSyncChecks(suppress: boolean): void
Parameters
- suppress: boolean
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1515

syncGameState

syncGameState(): Promise<void>
Returns Promise<void>
- Defined in src/game/multiplayer/Multiplayer.ts:1519

syncPacket

syncPacket<T>(packet: IPacket<any>, clientSide?: NullaryFunction<T>, checkId?: boolean, wait?: number | true): PromiseOr<undefined | T>
Sends a packet in a synchronized way to the server or clients

When ran as a server, clientSide() is called and the packet data is sent to all the clients.

When ran as a client, the packet is sent to the server. The server is expected to call this method, which in turn sends the packet back to the client. When the client receives the packet, this method a second time and clientSide() is called.
Type Parameters
- T = any
Parameters
- packet: IPacket<any>
  
  The packet
- Optional clientSide: NullaryFunction<T>
  
  The method to run for the client or server.
- Optional checkId: boolean
  
  When true, this packet will not be sent to the server/client if the same packet is already being processed. When false, this packet will not be sent if any packet is already being processed. Useful when dealing with methods that could end up sending multiple packets while a packet is already being processed.
- Optional wait: number | true
  
  When true, the client will keep track of what packets it sent to the server. If the client calls this method again before the server responds, it will not send a duplicate packet. It will wait for the server to send the packet back before allowing another one to be sent. When true, it will keep track of duplicate packets based on the packet type. When it's a number, it will keep track of duplicate packets based on the packet type + the number.
Returns PromiseOr<undefined | T>
- Defined in src/game/multiplayer/Multiplayer.ts:1218

updateGlobalServerDirectory

updateGlobalServerDirectory(): void
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1611

updateOptions

updateOptions(updates: Partial<IMultiplayerOptions>): void
Parameters
- updates: Partial<IMultiplayerOptions>
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:375

updatePlayerId

updatePlayerId(oldPid: number, newPid: number): void
Parameters
- oldPid: number
- newPid: number
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:1497

updateSyncChecks

updateSyncChecks(syncChecks: boolean | MultiplayerSyncCheck[] | MultiplayerSyncCheckLevel): void
Helper method for updating sync checks multiplayer.updateSyncChecks("normal") multiplayer.updateSyncChecks("verbose")
Parameters
- syncChecks: boolean | MultiplayerSyncCheck[] | MultiplayerSyncCheckLevel
Returns void
- Defined in src/game/multiplayer/Multiplayer.ts:414

verifyState

verifyState(): boolean
Sanity checks for the state of multiplayer

Returns
True when the state is invalid

Returns boolean
- Defined in src/game/multiplayer/Multiplayer.ts:924

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns default

Properties

Readonly event

Accessors

areSyncChecksSuppressed

Returns boolean

isClient

Returns boolean

isConnected

Returns boolean

isPacketProcessingPaused

Returns boolean

isProcessingPacket

Returns boolean

isServer

Returns boolean

options

Returns ImmutableObject<IMultiplayerOptions>

Methods

addAfterSyncChecks

Parameters

packet: IPacket<any>

Returns void

addBeforeSyncChecks

Parameters

packet: IPacket<any>

Returns void

addSyncCheck

Parameters

syncCheck: MultiplayerSyncCheck

value: any

addStackTrace: boolean = false

Returns void

addSyncCheckWithSeed

Parameters

island: default

syncCheck: MultiplayerSyncCheck

Rest ...messages: any[]

Returns void

checkConnection

Returns Promise<void>

clearSteamNetworkConnectionWebRTCFallbackTimer

Returns void

closeConnection

Parameters

reason: DisconnectReason

connection: IConnection

Returns boolean

convertGameCodeToServerInfo

Parameters

gameCode: string

Returns ServerInfo

createOrExtendSteamNetworkConnectionWebRTCFallbackTimer

Parameters

timeoutTime: number

Returns void

createServer

Parameters

serverInfo: ServerInfo

Returns void

disconnect

Returns

Parameters

reason: DisconnectReason

args: any[] = []

unloadingOrResetGameState: boolean = false

Returns Promise<boolean>

disconnectAndResetGameState

Parameters

reason: UnableToJoinGame

unableToJoinReason: UnableToJoinReason

`Readonly` event

`Rest` ...messages: any[]

`Optional` reasonDescription: any[]

`Optional` options: Partial<IJoinServerOptions>