pocketmine\network\mcpe\protocol\RequestAbilityPacket Class Reference

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

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

Public Member Functions
	__get ($name)
	__set ($name, $value)
	canBeSentBeforeLogin ()
	decode (ByteBufferReader $in)
	encode (ByteBufferWriter $out)
	getAbilityId ()
	getAbilityValue ()
	getName ()
	handle (PacketHandlerInterface $handler)
	pid ()

Static Public Member Functions
static	create (int $abilityId, float|bool $abilityValue)

Public Attributes
int	$recipientSubId = 0
int	$senderSubId = 0
const	ABILITY_FLYING = 9
const	ABILITY_NOCLIP = 17
const	NETWORK_ID = ProtocolInfo::REQUEST_ABILITY_PACKET
const	PID_MASK = 0x3ff

Protected Member Functions
	decodeHeader (ByteBufferReader $in)
	decodePayload (ByteBufferReader $in)
	encodeHeader (ByteBufferWriter $out)
	encodePayload (ByteBufferWriter $out)

Detailed Description

Sent by the client to request server enabling/disabling/changing certain abilities, such as flying, noclip, etc. As of 1.19.0, the vanilla server only handles this for flying/noclip, despite there being a large range of additional abilities which could be requested, and the packet supporting the use of float values.

Definition at line 31 of file RequestAbilityPacket.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\DataPacket::canBeSentBeforeLogin ( )

inherited

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 44 of file DataPacket.php.

create()

static pocketmine\network\mcpe\protocol\RequestAbilityPacket::create ( int $abilityId, float|bool $abilityValue )

static

@generate-create-func

Definition at line 46 of file RequestAbilityPacket.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\RequestAbilityPacket::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 57 of file RequestAbilityPacket.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\RequestAbilityPacket::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 74 of file RequestAbilityPacket.php.

getAbilityId()

pocketmine\network\mcpe\protocol\RequestAbilityPacket::getAbilityId

(

)

Definition at line 53 of file RequestAbilityPacket.php.

getAbilityValue()

pocketmine\network\mcpe\protocol\RequestAbilityPacket::getAbilityValue

(

)

Definition at line 55 of file RequestAbilityPacket.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\RequestAbilityPacket::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 87 of file RequestAbilityPacket.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.

ABILITY_FLYING

const pocketmine\network\mcpe\protocol\RequestAbilityPacket::ABILITY_FLYING = 9

Definition at line 37 of file RequestAbilityPacket.php.

ABILITY_NOCLIP

const pocketmine\network\mcpe\protocol\RequestAbilityPacket::ABILITY_NOCLIP = 17

Definition at line 38 of file RequestAbilityPacket.php.

NETWORK_ID

const pocketmine\network\mcpe\protocol\RequestAbilityPacket::NETWORK_ID = ProtocolInfo::REQUEST_ABILITY_PACKET

Definition at line 32 of file RequestAbilityPacket.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:

• RequestAbilityPacket.php