Class: Network

Constructors

constructor

• new Network(options?): Network

Parameters

Name	Type
options	Partial<NetworkOptions>

Returns

Network

Properties

clientInfo

• clientInfo: Object

Type declaration

Name	Type
id	string
metadata?	Record<string, any>
username	string

---

connected

• connected: boolean = false

---

intercepts

• intercepts: NetIntercept[] = []

---

joined

• joined: boolean = false

---

onConnect

• onConnect: () => void

Type declaration

▸ (): void

Returns

void

---

onDisconnect

• onDisconnect: () => void

Type declaration

▸ (): void

Returns

void

---

onJoin

• onJoin: (world: string) => void

Type declaration

▸ (world): void

Parameters

Name	Type
world	string

Returns

void

---

onLeave

• onLeave: (world: string) => void

Type declaration

▸ (world): void

Parameters

Name	Type
world	string

Returns

void

---

options

• options: NetworkOptions

---

socket

• socket: URL

---

url

• url: Url<{ [key: string]: any; }>

---

world

• world: string

---

ws

• ws: ProtocolWS

Accessors

concurrentWorkers

• get concurrentWorkers(): number

Returns

number

---

packetQueueLength

• get packetQueueLength(): number

Returns

number

---

rtcConnected

• get rtcConnected(): boolean

Returns

boolean

Methods

action

▸ action(type, data?): Promise<void>

Parameters

Name	Type
type	string
data?	any

Returns

Promise<void>

---

connect

▸ connect(serverURL, options?): Promise<Network>

Parameters

Name	Type
serverURL	string
options	NetworkConnectionOptions

Returns

Promise<Network>

---

connectWebRTC

▸ connectWebRTC(): Promise<void>

Returns

Promise<void>

---

disconnect

▸ disconnect(): void

Returns

void

---

flush

▸ flush(): void

Returns

void

---

join

▸ join(world): Promise<Network>

Parameters

Name	Type
world	string

Returns

Promise<Network>

---

leave

▸ leave(): void

Returns

void

---

register

▸ register(...intercepts): Network

Parameters

Name	Type
...intercepts	NetIntercept[]

Returns

Network

---

send

▸ send(event): void

Parameters

Name	Type
event	any

Returns

void

---

setID

▸ setID(id): void

Parameters

Name	Type
id	string

Returns

void

---

setMetadata

▸ setMetadata(metadata): void

Parameters

Name	Type
metadata	Record<string, any>

Returns

void

---

setUsername

▸ setUsername(username): void

Parameters

Name	Type
username	string

Returns

void

---

sync

▸ sync(): void

Returns

void

---

unregister

▸ unregister(...intercepts): Network

Parameters

Name	Type
...intercepts	NetIntercept[]

Returns

Network