Global Net Api

GL.net

The net api extends EventEmitter2 and uses wildcards with ”:” as a delimiter.

The following events are emitted:

// fired when data is recieved on a certain channel
net.on("CHANNEL", (data, editFn) => {})

// fired when data is sent on a certain channel
net.on("send:CHANNEL", (data, editFn) => {})

// you can also use wildcards, eg
net.on("send:*", () => {})

Accessors

gamemode

Get Signature

get gamemode(): string

The id of the gamemode the player is currently playing

Returns

string

---

isHost

Get Signature

get isHost(): boolean

Whether the user is the one hosting the current game

Returns

boolean

---

room

Get Signature

get room(): any

The room that the client is connected to, or null if there is no connection

Returns

any

---

type

Get Signature

get type(): ConnectionType

Which type of server the client is currently connected to

Returns

ConnectionType

Methods

modifyFetchRequest()

modifyFetchRequest(id, path, callback): () => void

Runs a callback when a request is made that matches a certain path (can have wildcards)

Parameters

Parameter	Type
id	string
path	string
callback	(options) => any

Returns

Function

Returns

void

---

modifyFetchResponse()

modifyFetchResponse(id, path, callback): () => void

Runs a callback when a response is recieved for a request under a certain path (can have wildcards)

Parameters

Parameter	Type
id	string
path	string
callback	(response) => any

Returns

Function

Returns

void

---

offLoad()

offLoad(id): void

Cancels any calls to onLoad with the same id

Parameters

Parameter	Type
id	string

Returns

void

---

onLoad()

onLoad(id, callback, gamemode?): () => void

Runs a callback when the game is loaded, or runs it immediately if the game has already loaded

Parameters

Parameter	Type
id	string
callback	(type, gamemode) => void
gamemode?	string | string[]

Returns

Function

A function to cancel waiting for load

Returns

void

---

send()

send(channel, message?): void

Sends a message to the server on a specific channel

Parameters

Parameter	Type
channel	string
message?	any

Returns

void

---

stopModifyRequest()

stopModifyRequest(id): void

Stops any modifications made by modifyFetchRequest with the same id

Parameters

Parameter	Type
id	string

Returns

void

---

stopModifyResponse()

stopModifyResponse(id): void

Stops any modifications made by modifyFetchResponse with the same id

Parameters

Parameter	Type
id	string

Returns

void