Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NetworkClient

Hierarchy

  • NetworkClient

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private Optional assignedPlayerId

assignedPlayerId: any

Private classRegistry

classRegistry: any

Private connectToRTCServer

connectToRTCServer: any

Private handleDisconnect

handleDisconnect: any

Private Optional handshakeFulfillment

handshakeFulfillment: any

isConnected

isConnected: boolean

Private messageRouter

messageRouter: any

Private Optional networkPeer

networkPeer: any

onConnected

onConnected: SyncEvent<PlayerId>

onDisconnected

onDisconnected: VoidSyncEvent

Methods

close

  • close(): void

  • Returns void

connect

  • connect(serverWsUrl: string): Promise<void>

  • Parameters

    • serverWsUrl: string

    Returns Promise<void>

flushMessagesToNetwork

  • flushMessagesToNetwork(): void

  • Sends messages across the network

    Returns void

registerMessageHandler

  • registerMessageHandler<T>(ctor: new (...args: any[]) => T, handler: (t: T) => void): void

  • Type parameters

    Parameters

    • ctor: new (...args: any[]) => T
        • new (...args: any[]): T

        • Parameters

          • Rest ...args: any[]

          Returns T

    • handler: (t: T) => void
        • (t: T): void

        • Parameters

          • t: T

          Returns void

    Returns void

registerMessageType

  • registerMessageType<T>(ctor: new (...args: any[]) => T, uniqueMessageTypeName: string): void

  • Type parameters

    Parameters

    • ctor: new (...args: any[]) => T
        • new (...args: any[]): T

        • Parameters

          • Rest ...args: any[]

          Returns T

    • uniqueMessageTypeName: string

    Returns void

sendMessage

  • Places messages in to the outbound queue. Actual network send is done by flushMessagesToNetwork. Messages are unordered, prioritized individually, and can be given a TTL / marked expired to limit reliability.

    Parameters

    • message: Serializable
    • Optional onAck: () => void
        • (): void

        • Returns void

    Returns undefined | OutboundMessage

Generated using TypeDoc