Inheritance diagram for pocketmine\network\mcpe\protocol\NetworkSettingsPacket:

Collaboration diagram for pocketmine\network\mcpe\protocol\NetworkSettingsPacket:

Public Member Functions
	__get ($name)

	__set ($name, $value)

	canBeSentBeforeLogin ()

	decode (ByteBufferReader $in)

	encode (ByteBufferWriter $out)

	getClientThrottleScalar ()

	getClientThrottleThreshold ()

	getCompressionAlgorithm ()

	getCompressionThreshold ()

	getName ()

	handle (PacketHandlerInterface $handler)

	isEnableClientThrottling ()

	pid ()

Static Public Member Functions
static	create (int $compressionThreshold, int $compressionAlgorithm, bool $enableClientThrottling, int $clientThrottleThreshold, float $clientThrottleScalar)

Public Attributes
int	$recipientSubId = 0

int	$senderSubId = 0

const	COMPRESS_EVERYTHING = 1

const	COMPRESS_NOTHING = 0

const	NETWORK_ID = ProtocolInfo::NETWORK_SETTINGS_PACKET

const	PID_MASK = 0x3ff

Protected Member Functions
	decodeHeader (ByteBufferReader $in)

	decodePayload (ByteBufferReader $in)

	encodeHeader (ByteBufferWriter $out)

	encodePayload (ByteBufferWriter $out)

Detailed Description

This is the first packet sent by the server in a game session, in response to a network settings request (only if protocol versions are a match). It includes values for things like which compression algorithm to use, size threshold for compressing packets, and more.

Definition at line 29 of file NetworkSettingsPacket.php.

Member Function Documentation

◆ __get()

pocketmine\network\mcpe\protocol\DataPacket::__get ( $name )

inherited

Parameters

string $name

Returns: mixed

Definition at line 107 of file DataPacket.php.

◆ __set()

pocketmine\network\mcpe\protocol\DataPacket::__set	(		$name,
			$value )

inherited

Parameters

string	$name
mixed	$value

Definition at line 115 of file DataPacket.php.

◆ canBeSentBeforeLogin()

pocketmine\network\mcpe\protocol\NetworkSettingsPacket::canBeSentBeforeLogin ( )

Reimplemented from pocketmine\network\mcpe\protocol\DataPacket.

Definition at line 54 of file NetworkSettingsPacket.php.

◆ create()

static pocketmine\network\mcpe\protocol\NetworkSettingsPacket::create	(	int	$compressionThreshold,
		int	$compressionAlgorithm,
		bool	$enableClientThrottling,
		int	$clientThrottleThreshold,
		float	$clientThrottleScalar )

static

@generate-create-func

Definition at line 44 of file NetworkSettingsPacket.php.

◆ decode()

pocketmine\network\mcpe\protocol\DataPacket::decode ( ByteBufferReader $in )

finalinherited

Exceptions

PacketDecodeException

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 51 of file DataPacket.php.

◆ decodeHeader()

pocketmine\network\mcpe\protocol\DataPacket::decodeHeader ( ByteBufferReader $in )

protectedinherited

Exceptions

DataDecodeException
PacketDecodeException

Definition at line 64 of file DataPacket.php.

◆ decodePayload()

pocketmine\network\mcpe\protocol\NetworkSettingsPacket::decodePayload ( ByteBufferReader $in )

protected

Decodes the packet body, without the packet ID or other generic header fields.

Exceptions

PacketDecodeException
DataDecodeException

Reimplemented from pocketmine\network\mcpe\protocol\DataPacket.

Definition at line 73 of file NetworkSettingsPacket.php.

◆ encode()

pocketmine\network\mcpe\protocol\DataPacket::encode ( ByteBufferWriter $out )

finalinherited

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 84 of file DataPacket.php.

◆ encodeHeader()

pocketmine\network\mcpe\protocol\DataPacket::encodeHeader ( ByteBufferWriter $out )

protectedinherited

Definition at line 89 of file DataPacket.php.

◆ encodePayload()

pocketmine\network\mcpe\protocol\NetworkSettingsPacket::encodePayload ( ByteBufferWriter $out )

protected

Encodes the packet body, without the packet ID or other generic header fields.

Reimplemented from pocketmine\network\mcpe\protocol\DataPacket.

Definition at line 81 of file NetworkSettingsPacket.php.

◆ getClientThrottleScalar()

pocketmine\network\mcpe\protocol\NetworkSettingsPacket::getClientThrottleScalar ( )

Definition at line 71 of file NetworkSettingsPacket.php.

◆ getClientThrottleThreshold()

pocketmine\network\mcpe\protocol\NetworkSettingsPacket::getClientThrottleThreshold ( )

Definition at line 69 of file NetworkSettingsPacket.php.

◆ getCompressionAlgorithm()

pocketmine\network\mcpe\protocol\NetworkSettingsPacket::getCompressionAlgorithm ( )

See also: CompressionAlgorithm

Definition at line 65 of file NetworkSettingsPacket.php.

◆ getCompressionThreshold()

pocketmine\network\mcpe\protocol\NetworkSettingsPacket::getCompressionThreshold ( )

Definition at line 58 of file NetworkSettingsPacket.php.

◆ getName()

pocketmine\network\mcpe\protocol\DataPacket::getName ( )

inherited

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 40 of file DataPacket.php.

◆ handle()

pocketmine\network\mcpe\protocol\NetworkSettingsPacket::handle ( PacketHandlerInterface $handler )

Performs handling for this packet. Usually you'll want an appropriately named method in the session handler for this.

This method returns a bool to indicate whether the packet was handled or not. If the packet was unhandled, a debug message will be logged with a hexdump of the packet.

Typically this method returns the return value of the handler in the supplied PacketHandler. See other packets for examples how to implement this.

Returns: bool true if the packet was handled successfully, false if not.

Exceptions

PacketDecodeException if broken data was found in the packet

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 89 of file NetworkSettingsPacket.php.

◆ isEnableClientThrottling()

pocketmine\network\mcpe\protocol\NetworkSettingsPacket::isEnableClientThrottling ( )

Definition at line 67 of file NetworkSettingsPacket.php.

◆ pid()

pocketmine\network\mcpe\protocol\DataPacket::pid ( )

inherited

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 36 of file DataPacket.php.

Member Data Documentation

◆ $recipientSubId

int pocketmine\network\mcpe\protocol\DataPacket::$recipientSubId = 0

inherited

Definition at line 34 of file DataPacket.php.

◆ $senderSubId

int pocketmine\network\mcpe\protocol\DataPacket::$senderSubId = 0

inherited

Definition at line 33 of file DataPacket.php.

◆ COMPRESS_EVERYTHING

const pocketmine\network\mcpe\protocol\NetworkSettingsPacket::COMPRESS_EVERYTHING = 1

Definition at line 33 of file NetworkSettingsPacket.php.

◆ COMPRESS_NOTHING

const pocketmine\network\mcpe\protocol\NetworkSettingsPacket::COMPRESS_NOTHING = 0

Definition at line 32 of file NetworkSettingsPacket.php.

◆ NETWORK_ID

const pocketmine\network\mcpe\protocol\NetworkSettingsPacket::NETWORK_ID = ProtocolInfo::NETWORK_SETTINGS_PACKET

Definition at line 30 of file NetworkSettingsPacket.php.

◆ PID_MASK

const pocketmine\network\mcpe\protocol\DataPacket::PID_MASK = 0x3ff

inherited

Definition at line 27 of file DataPacket.php.

The documentation for this class was generated from the following file:

NetworkSettingsPacket.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ __get()

◆ __set()

◆ canBeSentBeforeLogin()

◆ create()

◆ decode()

◆ decodeHeader()

◆ decodePayload()

◆ encode()

◆ encodeHeader()

◆ encodePayload()

◆ getClientThrottleScalar()

◆ getClientThrottleThreshold()

◆ getCompressionAlgorithm()

◆ getCompressionThreshold()

◆ getName()

◆ handle()

◆ isEnableClientThrottling()

◆ pid()

Member Data Documentation

◆ $recipientSubId

◆ $senderSubId

◆ COMPRESS_EVERYTHING

◆ COMPRESS_NOTHING

◆ NETWORK_ID

◆ PID_MASK