Class RequestPacket<V, B, T>

constructor

• new RequestPacket<V, B, T extends (...args: Parameters<V>) => B>(
      id: string,
      meta?: Many<SerializerMetadata<Parameters<T>>>,
  ): RequestPacket<V, B, T>

  Create a RequestPacket with a unique id. Metadata can be provided to specify how the data should be serialized.

  Type Parameters

  • V
  • B
  • T extends (...args: Parameters<V>) => B

  Parameters

  • id: string

    Unique identifier for the request
  • Optionalmeta: Many<SerializerMetadata<Parameters<T>>>

    Metadata for serialization

  Returns RequestPacket<V, B, T>

ReadonlyclassName

Readonlyid

remoteFunction

serializer

OptionalvirtualClientHandler

OptionalvirtualServerHandler

destroy

• destroy(): void

  Cleans up any resources used by the packet.

  Returns void

fromClient

• fromClient(handler: (player: Player, ...args: Parameters<T>) => B): void

  Set up a handler for the server to respond to toServer. This function should only be called on the server to listen for requests made by the client.

  Parameters

  • handler: (player: Player, ...args: Parameters<T>) => B

    The handler to call when a request is made

  Returns void

fromServer

• fromServer(handler: (...args: Parameters<T>) => B): void

  Set up a handler for the client to respond to toClient. This function should only be called on the client to listen for queries made by the server.

  Parameters

  • handler: (...args: Parameters<T>) => B

    The handler to call when a toClient is made

  Returns void

toClient

• toClient(player: Player, ...args: Parameters<T>): B

  Query a client for a response. The client should have a handler set up with fromServer that can handle the toClient. Hence, this function should only be called on the server.

  Parameters

  • player: Player

    The player to send the toClient to
  • ...args: Parameters<T>

    The data to send

  Returns B

toServer

• toServer(...args: Parameters<T>): B

  Invoke the request on the server. The server should have a handler set up with fromClient that can handle the toServer. Hence, this function should only be called on the client.

  Parameters

  • ...args: Parameters<T>

    The data to send

  Returns B