Namespace Network

New module to work with client and server packets in multiplayer.

Index

Functions

Functions

addClientPacket

addClientPacket<T>(name: string, func: (packetData: T) => void): void

- Defined in core-engine.d.ts:8776
Event that is called when a client receives a packet with given name

Type parameters
- T: object
Parameters
- name: string
  
  name of the packet
- func: (packetData: T) => void
  - - (packetData: T): void
    - Parameters
      - packetData: T
      Returns void
Returns void

addServerPacket

addServerPacket<T>(name: string, func: (client: NetworkClient, data: T) => void): void

- Defined in core-engine.d.ts:8782
Event that is called when server receives a packet with the specified name from client

Type parameters
- T: object
Parameters
- name: string
  
  name of the packet
- func: (client: NetworkClient, data: T) => void
  - - (client: NetworkClient, data: T): void
    - Parameters
      - client: NetworkClient
      - data: T
      Returns void
Returns void

getClientForPlayer

getClientForPlayer(player: number): NetworkClient

- Defined in core-engine.d.ts:8770
Parameters
- player: number
Returns NetworkClient

Client object for player by player's entity id

getConnectedClients

getConnectedClients(): NetworkClient[]

- Defined in core-engine.d.ts:8760
Returns NetworkClient[]

array containing connected clients

getConnectedPlayers

getConnectedPlayers(): number[]

- Defined in core-engine.d.ts:8765
Returns number[]

array containing connected players uids

inRemoteWorld

inRemoteWorld(): boolean

- Defined in core-engine.d.ts:8810
Returns boolean

localToServerId

localToServerId(id: string | number): number

- Defined in core-engine.d.ts:8808
Converts item or block id from local to server value

Parameters
- id: string | number
Returns number

sendServerMessage

sendServerMessage(message: string): void

- Defined in core-engine.d.ts:8798
Sends message to all players

Parameters
- message: string
  
  text of the message
Returns void

sendToAllClients

sendToAllClients(name: string, packetData: object): void

- Defined in core-engine.d.ts:8787
Sends packet object with specified name to all clients

Parameters
- name: string
- packetData: object
Returns void

sendToServer

sendToServer(name: string, packetData: object): void

- Defined in core-engine.d.ts:8792
Sends packet object with the specified name from client to server

Parameters
- name: string
- packetData: object
Returns void

serverToLocalId

serverToLocalId(id: string | number): number

- Defined in core-engine.d.ts:8803
Converts item or block id from server to local value

Parameters
- id: string | number
Returns number

Generated using TypeDoc