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

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 cancel (int $formId, int $cancelReason)
 
static response (int $formId, string $formData)
 

Public Attributes

int $cancelReason
 
string $formData
 
int $formId
 
int $recipientSubId = 0
 
int $senderSubId = 0
 
const CANCEL_REASON_CLOSED = 0
 
const CANCEL_REASON_USER_BUSY = 1
 
const NETWORK_ID = ProtocolInfo::MODAL_FORM_RESPONSE_PACKET
 
const PID_MASK = 0x3ff
 

Protected Member Functions

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

Detailed Description

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

◆ cancel()

static pocketmine\network\mcpe\protocol\ModalFormResponsePacket::cancel ( int  $formId,
int  $cancelReason 
)
static

Definition at line 45 of file ModalFormResponsePacket.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\ModalFormResponsePacket::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 49 of file ModalFormResponsePacket.php.

◆ 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\ModalFormResponsePacket::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 55 of file ModalFormResponsePacket.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\ModalFormResponsePacket::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 62 of file ModalFormResponsePacket.php.

◆ pid()

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

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 34 of file DataPacket.php.

◆ response()

static pocketmine\network\mcpe\protocol\ModalFormResponsePacket::response ( int  $formId,
string  $formData 
)
static

Definition at line 41 of file ModalFormResponsePacket.php.

Member Data Documentation

◆ $cancelReason

int pocketmine\network\mcpe\protocol\ModalFormResponsePacket::$cancelReason

Definition at line 28 of file ModalFormResponsePacket.php.

◆ $formData

string pocketmine\network\mcpe\protocol\ModalFormResponsePacket::$formData

Definition at line 27 of file ModalFormResponsePacket.php.

◆ $formId

int pocketmine\network\mcpe\protocol\ModalFormResponsePacket::$formId

Definition at line 26 of file ModalFormResponsePacket.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.

◆ CANCEL_REASON_CLOSED

const pocketmine\network\mcpe\protocol\ModalFormResponsePacket::CANCEL_REASON_CLOSED = 0

Definition at line 22 of file ModalFormResponsePacket.php.

◆ CANCEL_REASON_USER_BUSY

const pocketmine\network\mcpe\protocol\ModalFormResponsePacket::CANCEL_REASON_USER_BUSY = 1

Sent if a form is sent when the player is on a loading screen

Definition at line 24 of file ModalFormResponsePacket.php.

◆ NETWORK_ID

const pocketmine\network\mcpe\protocol\ModalFormResponsePacket::NETWORK_ID = ProtocolInfo::MODAL_FORM_RESPONSE_PACKET

Definition at line 20 of file ModalFormResponsePacket.php.

◆ PID_MASK

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

Definition at line 25 of file DataPacket.php.


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