Class NetworkConnection

Main class to communicate with the networking backend

Implements

  • INetworkConnection

Constructors

constructor

Accessors

allowEditing connectionId currentLatency currentRoomName currentRoomViewId currentServerUrl isConnected isDebugEnabled isInRoom peer

Methods

beginListen beginListenBinary connect disconnect getViewOnlyUrl joinRoom leaveRoom registerProvider send sendBinary sendBufferedMessagesNow sendDeleteRemoteState sendDeleteRemoteStateAll sendPing stopListen stopListenBinary stopListening tryGetState userIsInRoom usersInRoom

Constructors

constructor

Accessors

allowEditing

  • get allowEditing(): boolean

  • True when connected to a room via a regular url, otherwise (when using a view only url) false indicating that the user should not be able to modify the scene

    Returns boolean

connectionId

  • get connectionId(): string

  • The connection id of the local user - it is given by the networking backend and can not be changed

    Returns string

currentLatency

  • get currentLatency(): number

  • Latency to currently connected backend server

    Returns number

currentRoomName

  • get currentRoomName(): string

  • The name of the room the user is currently connected to

    Returns string

currentRoomViewId

  • get currentRoomViewId(): string

  • The view id of the room the user is currently connected to.

    Returns string

currentServerUrl

  • get currentServerUrl(): string

  • The current server url that the networking backend is connected to (e.g. the url of the websocket server)

    Returns string

isConnected

  • get isConnected(): boolean

  • True when connected to the networking backend

    Returns boolean

isDebugEnabled

  • get isDebugEnabled(): boolean

  • Returns boolean

isInRoom

  • get isInRoom(): boolean

  • True if connected to a networked room. Use the joinRoom function or a SyncedRoom component

    Returns boolean

peer

Methods

beginListen

  • beginListen(key, callback): Function

  • Use to start listening to networking events

    Parameters

    Returns Function

beginListenBinary

  • beginListenBinary(identifier, callback): BinaryCallback

  • Use to start listening to networking binary events

    Parameters

    • identifier: string
    • callback: BinaryCallback

    Returns BinaryCallback

connect

  • connect(): Promise<boolean>

  • Used to connect to the networking server

    Returns Promise<boolean>

disconnect

  • disconnect(): void

  • Used to disconnect from the networking server

    Returns void

getViewOnlyUrl

  • getViewOnlyUrl(): string

  • Returns a url that can be shared with others to view the current room in view only mode.
    This is useful for sharing a room with others without allowing them to modify the scene.
    Use connection.allowEditing to check if the current room is in view only mode.

    Returns string

joinRoom

  • joinRoom(room, viewOnly?): boolean

  • Joins a networked room. If you don't want to manage a connection yourself you can use a SyncedRoom component as well

    Parameters

    • room: string
    • viewOnly: boolean = false

    Returns boolean

leaveRoom

  • leaveRoom(room?): boolean

  • Use to leave a room that you are currently connected to (use leaveRoom() to disconnect from the currently active room but you can also specify a room name)

    Parameters

    • room: string = null

    Returns boolean

registerProvider

  • registerProvider(prov): void

  • Use to override the networking server backend url. This is what the Networking component uses to modify the backend url

    Parameters

    • prov: INetworkingWebsocketUrlProvider

    Returns void

send

  • send<T>(key, data?, queue?): void

  • Send a message to the networking backend - it will broadcasted to all connected users in the same room by default

    Type Parameters

    • T extends WebsocketSendType

    Parameters

    • key: string
    • data: T = null
    • queue: SendQueue = SendQueue.Queued

    Returns void

sendBinary

  • sendBinary(bin): void

  • Send a binary message to the server (broadcasted to all connected users)

    Parameters

    Returns void

sendBufferedMessagesNow

  • sendBufferedMessagesNow(): void

  • Returns void

sendDeleteRemoteState

  • sendDeleteRemoteState(guid): void

  • Use to delete state for a given guid on the server

    Parameters

    • guid: string

    Returns void

sendDeleteRemoteStateAll

  • sendDeleteRemoteStateAll(): void

  • Use to delete all state in the currently connected room on the server

    Returns void

sendPing

  • sendPing(): void

  • A ping is sent to the server at a regular interval while the browser tab is active. This method can be used to send additional ping messages when needed so that the user doesn't get disconnected from the networking backend

    Returns void

stopListen

  • stopListen(key, callback): void

  • Use to stop listening to networking events

    Parameters

    Returns void

stopListenBinary

  • stopListenBinary(identifier, callback): void

  • Use to stop listening to networking binary events

    Parameters

    • identifier: string
    • callback: any

    Returns void

stopListening

  • stopListening(key, callback): void

  • Parameters

    Returns void

    Deprecated

    please use stopListen instead (2.65.2-pre)

tryGetState

  • tryGetState(guid): IModel

  • Returns the state of a given guid.

    Parameters

    • guid: string

    Returns IModel

userIsInRoom

  • userIsInRoom(id): boolean

  • Returns true if a user with the given connectionId is in the room

    Parameters

    • id: string

    Returns boolean

usersInRoom

  • usersInRoom(target?): string[]

  • Returns a list of all user ids in the current room

    Parameters

    • target: string[] = null

    Returns string[]

Settings

Member Visibility

Theme

On This Page

constructorallowEditingconnectionIdcurrentLatencycurrentRoomNamecurrentRoomViewIdcurrentServerUrlisConnectedisDebugEnabledisInRoompeerbeginListenbeginListenBinaryconnectdisconnectgetViewOnlyUrljoinRoomleaveRoomregisterProvidersendsendBinarysendBufferedMessagesNowsendDeleteRemoteStatesendDeleteRemoteStateAllsendPingstopListenstopListenBinarystopListeningtryGetStateuserIsInRoomusersInRoom

Generated using TypeDoc