Class IGEHandler

Manages network IGE cancelling

Index

Constructors

Methods

fromSnapshot receive send snapshot

Constructors

constructor

new IGEHandler(players): IGEHandler
Manages network IGE cancelling
Parameters
- players: number[]
  list of player ids
Returns IGEHandler
- Defined in src/engine/multiplayer/ige.ts:45

Methods

fromSnapshot

fromSnapshot(snapshot): void
Parameters
- snapshot: IGEHandlerSnapshot
Returns void
- Defined in src/engine/multiplayer/ige.ts:155

receive

receive(garbage): number
Receives a garbage from a player and processes it.
Parameters
- garbage: {
      ackiid: number;
      amount: number;
      iid: number;
      playerID: number;
  }
  garbage object of data
  - ackiid: number
    The IID of the last acknowledged item.
  - amount: number
    The amount of the incoming item.
  - iid: number
    The IID of the incoming item.
  - playerID: number
    The ID of the player sending the garbage.
Returns number
The remaining amount after processing the message.

Throws
If the player is not found.
- Defined in src/engine/multiplayer/ige.ts:98

send

send(options): void
Sends a message to a player.
Parameters
- options: {
  amount: number;
  playerID: number;
  }
  info on sending player
  - amount: number
    The amount of the message.
  - playerID: number
    The ID of the player to send the message to.
Returns void
Throws
If the player is not found.
- Defined in src/engine/multiplayer/ige.ts:59

snapshot

snapshot(): IGEHandlerSnapshot
Returns IGEHandlerSnapshot
- Defined in src/engine/multiplayer/ige.ts:148