api.packet

Members

api.packet.on()

api.packet.on<const D extends PacketDirection>(query: PacketSelector & { readonly direction: D; }, handler: (packet: PacketForDirection<D>) => ScriptCallbackResult): Effect.Effect<() => void, never, never>
api.packet.on(query: PacketSelector | undefined, handler: (packet: Packet) => ScriptCallbackResult): Effect.Effect<() => void, never, never>

Returns: () => void

Errors: never

api.packet.once()

api.packet.once<const D extends PacketDirection, E = never, R = never>(query: PacketSelector & { readonly direction: D; }, options?: TriggeredWaitOptions<E, R> | undefined): Effect.Effect<PacketForDirection<D> | null, E, Exclude<R, Scope.Scope>>
api.packet.once<E = never, R = never>(selector?: PacketSelector | undefined, options?: TriggeredWaitOptions<E, R> | undefined): Effect.Effect<FlashPacket | null, E, Exclude<R, Scope.Scope>>

Returns: Packet | null

Errors: E

api.packet.sendToClient()

api.packet.sendToClient(packet: string, encoding?: ClientPacketEncoding): Effect.Effect<boolean>

Returns: boolean

Errors: never

api.packet.sendToServer()

api.packet.sendToServer(packet: string, encoding?: ServerPacketEncoding): Effect.Effect<boolean>

Returns: boolean

Errors: never