Class SoulFireProtocol

Advanced access to SoulFire's native Minecraft packet codec.

Encoded bytes use the native protocol reported by info, not the remote server protocol. SoulFire applies ViaVersion translation afterward.

Index

Constructors

Methods

info packets schemas send

Constructors

constructor

new SoulFireProtocol(
    instanceId: string,
    botId: string,
    client: Client<typeof BotProtocolService>,
): SoulFireProtocol
Parameters
- instanceId: string
- botId: string
- client: Client<typeof BotProtocolService>
Returns SoulFireProtocol
- Defined in sdk/typescript/src/protocol.ts:39

Methods

info

info(options?: CallOptions): Effect<BotProtocolInfo, SoulFireOperationError>
Parameters
- Optionaloptions: CallOptions
Returns Effect<BotProtocolInfo, SoulFireOperationError>
- Defined in sdk/typescript/src/protocol.ts:45

packets

packets(
options?: WatchPacketsOptions,
): Stream<RawPacketEvent, SoulFireOperationError>
Parameters
- options: WatchPacketsOptions = {}
Returns Stream<RawPacketEvent, SoulFireOperationError>
- Defined in sdk/typescript/src/protocol.ts:68

schemas

schemas(
direction: PacketDirection,
options?: CallOptions,
): Effect<readonly PacketSchema[], SoulFireOperationError>
Parameters
- direction: PacketDirection
- Optionaloptions: CallOptions
Returns Effect<readonly PacketSchema[], SoulFireOperationError>
- Defined in sdk/typescript/src/protocol.ts:53

send

send(
encodedPacket: Uint8Array,
options?: SendRawPacketOptions,
): Effect<{ encodedBytes: number; name: string }, SoulFireOperationError>
Parameters
- encodedPacket: Uint8Array
- options: SendRawPacketOptions = {}
Returns Effect<{ encodedBytes: number; name: string }, SoulFireOperationError>
- Defined in sdk/typescript/src/protocol.ts:84