Class RCONPacket

Hierarchy

  • RCONPacket

Constructors

constructor

Properties

buf payload type MAX_CLIENT_PAYLOAD_LENGTH MAX_SERVER_PAYLOAD_LENGTH

Methods

read write

Constructors

constructor

  • new RCONPacket(buf?: BufWrapper<BufWrapperPlugins>): RCONPacket

  • Read or write a packet

    Parameters

    • Optional buf: BufWrapper<BufWrapperPlugins>

      Buffer to create the packet from, can be undefined if you are building a packet

    Returns RCONPacket

Properties

buf

buf: BufWrapper<BufWrapperPlugins>

BufWrapper instance that wraps the buffer for this packet

payload

payload: string

Payload of the packet

type

type: RCONPacketType

Type of the packet

See

https://wiki.vg/RCON#Packets

Static Readonly MAX_CLIENT_PAYLOAD_LENGTH

MAX_CLIENT_PAYLOAD_LENGTH: 1460 = 1460

Maximum client to server packet length

Static Readonly MAX_SERVER_PAYLOAD_LENGTH

MAX_SERVER_PAYLOAD_LENGTH: 4110 = 4110

Maximum server to client packet length

Methods

read

write

  • Write the data to the packet

    Parameters

    • Optional type: RCONPacketType

      Type of the RCONPacket

    • Optional payload: string

      Payload for this packet

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc