pocketmine\network\mcpe\protocol\BookEditPacket Class Reference

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

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

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

Public Attributes
string	$author
int	$inventorySlot
int	$pageNumber
string	$photoName
int	$recipientSubId = 0
int	$secondaryPageNumber
int	$senderSubId = 0
string	$text
string	$title
int	$type
string	$xuid
const	NETWORK_ID = ProtocolInfo::BOOK_EDIT_PACKET
const	PID_MASK = 0x3ff
const	TYPE_ADD_PAGE = 1
const	TYPE_DELETE_PAGE = 2
const	TYPE_REPLACE_PAGE = 0
const	TYPE_SIGN_BOOK = 4
const	TYPE_SWAP_PAGES = 3

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

Detailed Description

Definition at line 19 of file BookEditPacket.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.

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\BookEditPacket::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 38 of file BookEditPacket.php.

References pocketmine\utils\BinaryStream\getByte(), and 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\BookEditPacket::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 66 of file BookEditPacket.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\BookEditPacket::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 94 of file BookEditPacket.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

$author

string pocketmine\network\mcpe\protocol\BookEditPacket::$author

Definition at line 35 of file BookEditPacket.php.

$inventorySlot

int pocketmine\network\mcpe\protocol\BookEditPacket::$inventorySlot

Definition at line 29 of file BookEditPacket.php.

$pageNumber

int pocketmine\network\mcpe\protocol\BookEditPacket::$pageNumber

Definition at line 30 of file BookEditPacket.php.

$photoName

string pocketmine\network\mcpe\protocol\BookEditPacket::$photoName

Definition at line 33 of file BookEditPacket.php.

$recipientSubId

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

inherited

Definition at line 32 of file DataPacket.php.

$secondaryPageNumber

int pocketmine\network\mcpe\protocol\BookEditPacket::$secondaryPageNumber

Definition at line 31 of file BookEditPacket.php.

$senderSubId

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

inherited

Definition at line 31 of file DataPacket.php.

$text

string pocketmine\network\mcpe\protocol\BookEditPacket::$text

Definition at line 32 of file BookEditPacket.php.

$title

string pocketmine\network\mcpe\protocol\BookEditPacket::$title

Definition at line 34 of file BookEditPacket.php.

$type

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

Definition at line 28 of file BookEditPacket.php.

$xuid

string pocketmine\network\mcpe\protocol\BookEditPacket::$xuid

Definition at line 36 of file BookEditPacket.php.

NETWORK_ID

const pocketmine\network\mcpe\protocol\BookEditPacket::NETWORK_ID = ProtocolInfo::BOOK_EDIT_PACKET

Definition at line 20 of file BookEditPacket.php.

PID_MASK

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

inherited

Definition at line 25 of file DataPacket.php.

TYPE_ADD_PAGE

const pocketmine\network\mcpe\protocol\BookEditPacket::TYPE_ADD_PAGE = 1

Definition at line 23 of file BookEditPacket.php.

TYPE_DELETE_PAGE

const pocketmine\network\mcpe\protocol\BookEditPacket::TYPE_DELETE_PAGE = 2

Definition at line 24 of file BookEditPacket.php.

TYPE_REPLACE_PAGE

const pocketmine\network\mcpe\protocol\BookEditPacket::TYPE_REPLACE_PAGE = 0

Definition at line 22 of file BookEditPacket.php.

TYPE_SIGN_BOOK

const pocketmine\network\mcpe\protocol\BookEditPacket::TYPE_SIGN_BOOK = 4

Definition at line 26 of file BookEditPacket.php.

TYPE_SWAP_PAGES

const pocketmine\network\mcpe\protocol\BookEditPacket::TYPE_SWAP_PAGES = 3

Definition at line 25 of file BookEditPacket.php.

---

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

• BookEditPacket.php