PocketMine-MP 5.15.1 git-fb9a74e8799c71ed8292cfa53abe7a4c9204629d
pocketmine\network\mcpe\protocol\UpdateSoftEnumPacket Class Reference
+ Inheritance diagram for pocketmine\network\mcpe\protocol\UpdateSoftEnumPacket:
+ Collaboration diagram for pocketmine\network\mcpe\protocol\UpdateSoftEnumPacket:

Public Member Functions

 __get ($name)
 
 __set ($name, $value)
 
 canBeSentBeforeLogin ()
 
 decode (PacketSerializer $in)
 
 encode (PacketSerializer $out)
 
 getName ()
 
 handle (PacketHandlerInterface $handler)
 
 pid ()
 

Static Public Member Functions

static create (string $enumName, array $values, int $type)
 

Public Attributes

string $enumName
 
int $recipientSubId = 0
 
int $senderSubId = 0
 
int $type
 
array $values = []
 
const NETWORK_ID = ProtocolInfo::UPDATE_SOFT_ENUM_PACKET
 
const PID_MASK = 0x3ff
 
const TYPE_ADD = 0
 
const TYPE_REMOVE = 1
 
const TYPE_SET = 2
 

Protected Member Functions

 decodeHeader (PacketSerializer $in)
 
 decodePayload (PacketSerializer $in)
 
 encodeHeader (PacketSerializer $out)
 
 encodePayload (PacketSerializer $out)
 

Detailed Description

Definition at line 20 of file UpdateSoftEnumPacket.php.

Member Function Documentation

◆ __get()

pocketmine\network\mcpe\protocol\DataPacket::__get (   $name)
inherited
Parameters
string$name
Returns
mixed

Definition at line 105 of file DataPacket.php.

◆ __set()

pocketmine\network\mcpe\protocol\DataPacket::__set (   $name,
  $value 
)
inherited
Parameters
string$name
mixed$value

Definition at line 113 of file DataPacket.php.

◆ canBeSentBeforeLogin()

pocketmine\network\mcpe\protocol\DataPacket::canBeSentBeforeLogin ( )
inherited

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 42 of file DataPacket.php.

◆ create()

static pocketmine\network\mcpe\protocol\UpdateSoftEnumPacket::create ( string  $enumName,
array  $values,
int  $type 
)
static

@generate-create-func

Parameters
string[]$values

Definition at line 36 of file UpdateSoftEnumPacket.php.

◆ decode()

pocketmine\network\mcpe\protocol\DataPacket::decode ( PacketSerializer  $in)
finalinherited
Exceptions
PacketDecodeException

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 49 of file DataPacket.php.

◆ decodeHeader()

pocketmine\network\mcpe\protocol\DataPacket::decodeHeader ( PacketSerializer  $in)
protectedinherited
Exceptions
BinaryDataException
PacketDecodeException

Definition at line 62 of file DataPacket.php.

◆ decodePayload()

pocketmine\network\mcpe\protocol\UpdateSoftEnumPacket::decodePayload ( PacketSerializer  $in)
protected

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

Exceptions
PacketDecodeException
BinaryDataException

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

Definition at line 44 of file UpdateSoftEnumPacket.php.

References pocketmine\network\mcpe\protocol\serializer\PacketSerializer\getString().

+ Here is the call graph for this function:

◆ encode()

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

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 82 of file DataPacket.php.

◆ encodeHeader()

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

Definition at line 87 of file DataPacket.php.

◆ encodePayload()

pocketmine\network\mcpe\protocol\UpdateSoftEnumPacket::encodePayload ( PacketSerializer  $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 52 of file UpdateSoftEnumPacket.php.

◆ getName()

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

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 38 of file DataPacket.php.

◆ handle()

pocketmine\network\mcpe\protocol\UpdateSoftEnumPacket::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
PacketDecodeExceptionif broken data was found in the packet

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 61 of file UpdateSoftEnumPacket.php.

◆ pid()

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

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 34 of file DataPacket.php.

Member Data Documentation

◆ $enumName

string pocketmine\network\mcpe\protocol\UpdateSoftEnumPacket::$enumName

Definition at line 27 of file UpdateSoftEnumPacket.php.

◆ $recipientSubId

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

Definition at line 32 of file DataPacket.php.

◆ $senderSubId

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

Definition at line 31 of file DataPacket.php.

◆ $type

int pocketmine\network\mcpe\protocol\UpdateSoftEnumPacket::$type

Definition at line 30 of file UpdateSoftEnumPacket.php.

◆ $values

array pocketmine\network\mcpe\protocol\UpdateSoftEnumPacket::$values = []

Definition at line 29 of file UpdateSoftEnumPacket.php.

◆ NETWORK_ID

const pocketmine\network\mcpe\protocol\UpdateSoftEnumPacket::NETWORK_ID = ProtocolInfo::UPDATE_SOFT_ENUM_PACKET

Definition at line 21 of file UpdateSoftEnumPacket.php.

◆ PID_MASK

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

Definition at line 25 of file DataPacket.php.

◆ TYPE_ADD

const pocketmine\network\mcpe\protocol\UpdateSoftEnumPacket::TYPE_ADD = 0

Definition at line 23 of file UpdateSoftEnumPacket.php.

◆ TYPE_REMOVE

const pocketmine\network\mcpe\protocol\UpdateSoftEnumPacket::TYPE_REMOVE = 1

Definition at line 24 of file UpdateSoftEnumPacket.php.

◆ TYPE_SET

const pocketmine\network\mcpe\protocol\UpdateSoftEnumPacket::TYPE_SET = 2

Definition at line 25 of file UpdateSoftEnumPacket.php.


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