pocketmine\network\mcpe\protocol\PlayerListPacket Class Reference

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

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

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

Static Public Member Functions
static	add (array $entries)
static	remove (array $entries)

Public Attributes
array	$entries = []
int	$recipientSubId = 0
int	$senderSubId = 0
int	$type
const	NETWORK_ID = ProtocolInfo::PLAYER_LIST_PACKET
const	PID_MASK = 0x3ff
const	TYPE_ADD = 0
const	TYPE_REMOVE = 1

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

Detailed Description

Definition at line 27 of file PlayerListPacket.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.

add()

static pocketmine\network\mcpe\protocol\PlayerListPacket::add ( array $entries )

static

Parameters

PlayerListEntry[]

$entries

Definition at line 51 of file PlayerListPacket.php.

canBeSentBeforeLogin()

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

inherited

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 44 of file DataPacket.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\PlayerListPacket::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 62 of file PlayerListPacket.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\PlayerListPacket::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 93 of file PlayerListPacket.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\PlayerListPacket::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 120 of file PlayerListPacket.php.

pid()

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

inherited

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 36 of file DataPacket.php.

remove()

static pocketmine\network\mcpe\protocol\PlayerListPacket::remove ( array $entries )

static

Parameters

PlayerListEntry[]

$entries

Definition at line 58 of file PlayerListPacket.php.

Member Data Documentation

$entries

array pocketmine\network\mcpe\protocol\PlayerListPacket::$entries = []

Definition at line 35 of file PlayerListPacket.php.

$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.

$type

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

Definition at line 33 of file PlayerListPacket.php.

NETWORK_ID

const pocketmine\network\mcpe\protocol\PlayerListPacket::NETWORK_ID = ProtocolInfo::PLAYER_LIST_PACKET

Definition at line 28 of file PlayerListPacket.php.

PID_MASK

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

inherited

Definition at line 27 of file DataPacket.php.

TYPE_ADD

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

Definition at line 30 of file PlayerListPacket.php.

TYPE_REMOVE

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

Definition at line 31 of file PlayerListPacket.php.

---

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

• PlayerListPacket.php