Class Network

constructor

• new Network(): Network

• Returns Network

name

getPacket

• getPacket(pPacketName: string): undefined | number

• Gets the index of a packet.

  Parameters

  • pPacketName: string

    The name of the packet.

  Returns undefined | number

on

• on<T extends unknown[]>(
      pPacketName: string,
      pListener: NetworkListener<T>,
  ): void

• Register a listener for a packet.

  Type Parameters

  • T extends unknown[]

  Parameters

  • pPacketName: string

    The name of the packet that will be listened to.
  • pListener: NetworkListener<T>

    The listener that will be called when the packet is received.

  Returns void

onNetwork

• onNetwork(
      pClient: Client,
      pPacketName: string | number,
      pData?: unknown[],
      pVerbose?: boolean,
  ): void

• API for receiving data from the server.

  Parameters

  • pClient: Client

    The client involved with this packet.
  • pPacketName: string | number

    The name of the packet that was sent.
  • pData: unknown[] = []

    The data that was sent.
  • OptionalpVerbose: boolean

    If the plugin should log packets.

  Returns void

onRegistered

• onRegistered(): void

• The entry point for custom behavior after registration for custom plugins.

  Returns void

registerPackets

• registerPackets(pPackets: readonly string[]): void

• Register the packets registry.

  Parameters

  • pPackets: readonly string[]

    An array of strings that represent the packet names.

  Returns void