@minecraft/server-net

@minecraft/server-net as Basalt provides it: its packet events, which see every packet a player sends and is sent, and may stop it; its HTTP client, http; and Basalt’s own WebSocket.

Requests and sockets run off the plugin’s thread and are held to basalt.toml’s script_net_enabled, script_net_allowed_hosts and script_net_max_body_bytes. BDS offers this module only to packs its config/ permissions allow.

A handler runs while the connection waits, at most 50 ms, on every packet it hears, so narrow a subscription with PacketEventOptions. To watch without making anyone wait, use Basalt’s system.afterEvents.packetReceive and packetSend of @minecraft/server.

import { beforeEvents } from '@minecraft/server-net';

Events

PacketReceivedBeforeEventInterfaceA packet a player sent, split from its batch but not yet handled.beforeEvents.packetReceive PacketSendBeforeEventInterfaceA packet about to go to a player in a batch.beforeEvents.packetSend

Classes

HttpClientClassMakes HTTP requests. HttpErrorClassWhat a request that got no answer rejects with. HttpHeaderClassOne HTTP header. HttpRequestClassAn HTTP request for HttpClient.request. HttpResponseClassThe answer to an HttpRequest, whatever its status. NetworkBeforeEventsClass WebSocketClassBasalt's own, as the browser's WebSocket: a ws or wss connection, text messages each way.

Interfaces

WebSocketCloseEventInterfaceA WebSocket closing. WebSocketErrorEventInterfaceA WebSocket that failed; a close event follows. WebSocketEventMapInterface WebSocketMessageEventInterfaceA WebSocket message. WebSocketOpenEventInterfaceA WebSocket that opened.

Enums

HttpRequestMethodEnumThe methods an HttpRequest may use. PacketIdEnumEvery packet of the protocol Basalt speaks, by its name.

Types

HttpErrorReasonTypeWhy an HttpError happened.

Options

PacketEventOptionsInterfaceWhich packets a subscription hears: those monitored, or all but those ignored. WebSocketOptionsInterfaceWhat a WebSocket is opened with.

Constants

beforeEvents

const beforeEvents: NetworkBeforeEvents;

Types

NetworkBeforeEvents

http

const http: HttpClient;

Types

HttpClient