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

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 $structureTemplateName, BlockPosition $structureBlockPosition, StructureSettings $structureSettings, int $requestType)
 

Public Attributes

int $recipientSubId = 0
 
int $requestType
 
int $senderSubId = 0
 
BlockPosition $structureBlockPosition
 
StructureSettings $structureSettings
 
string $structureTemplateName
 
const NETWORK_ID = ProtocolInfo::STRUCTURE_TEMPLATE_DATA_REQUEST_PACKET
 
const PID_MASK = 0x3ff
 
const TYPE_EXPORT_FROM_LOAD_MODE = 2
 
const TYPE_EXPORT_FROM_SAVE_MODE = 1
 
const TYPE_IMPORT = 4
 
const TYPE_QUERY_SAVED_STRUCTURE = 3
 

Protected Member Functions

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

Detailed Description

Definition at line 21 of file StructureTemplateDataRequestPacket.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\StructureTemplateDataRequestPacket::create ( string  $structureTemplateName,
BlockPosition  $structureBlockPosition,
StructureSettings  $structureSettings,
int  $requestType 
)
static

@generate-create-func

Definition at line 37 of file StructureTemplateDataRequestPacket.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\StructureTemplateDataRequestPacket::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 46 of file StructureTemplateDataRequestPacket.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\StructureTemplateDataRequestPacket::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 53 of file StructureTemplateDataRequestPacket.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\StructureTemplateDataRequestPacket::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 60 of file StructureTemplateDataRequestPacket.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

◆ $recipientSubId

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

Definition at line 32 of file DataPacket.php.

◆ $requestType

int pocketmine\network\mcpe\protocol\StructureTemplateDataRequestPacket::$requestType

Definition at line 32 of file StructureTemplateDataRequestPacket.php.

◆ $senderSubId

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

Definition at line 31 of file DataPacket.php.

◆ $structureBlockPosition

BlockPosition pocketmine\network\mcpe\protocol\StructureTemplateDataRequestPacket::$structureBlockPosition

Definition at line 30 of file StructureTemplateDataRequestPacket.php.

◆ $structureSettings

StructureSettings pocketmine\network\mcpe\protocol\StructureTemplateDataRequestPacket::$structureSettings

Definition at line 31 of file StructureTemplateDataRequestPacket.php.

◆ $structureTemplateName

string pocketmine\network\mcpe\protocol\StructureTemplateDataRequestPacket::$structureTemplateName

Definition at line 29 of file StructureTemplateDataRequestPacket.php.

◆ NETWORK_ID

const pocketmine\network\mcpe\protocol\StructureTemplateDataRequestPacket::NETWORK_ID = ProtocolInfo::STRUCTURE_TEMPLATE_DATA_REQUEST_PACKET

Definition at line 22 of file StructureTemplateDataRequestPacket.php.

◆ PID_MASK

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

Definition at line 25 of file DataPacket.php.

◆ TYPE_EXPORT_FROM_LOAD_MODE

const pocketmine\network\mcpe\protocol\StructureTemplateDataRequestPacket::TYPE_EXPORT_FROM_LOAD_MODE = 2

Definition at line 25 of file StructureTemplateDataRequestPacket.php.

◆ TYPE_EXPORT_FROM_SAVE_MODE

const pocketmine\network\mcpe\protocol\StructureTemplateDataRequestPacket::TYPE_EXPORT_FROM_SAVE_MODE = 1

Definition at line 24 of file StructureTemplateDataRequestPacket.php.

◆ TYPE_IMPORT

const pocketmine\network\mcpe\protocol\StructureTemplateDataRequestPacket::TYPE_IMPORT = 4

Definition at line 27 of file StructureTemplateDataRequestPacket.php.

◆ TYPE_QUERY_SAVED_STRUCTURE

const pocketmine\network\mcpe\protocol\StructureTemplateDataRequestPacket::TYPE_QUERY_SAVED_STRUCTURE = 3

Definition at line 26 of file StructureTemplateDataRequestPacket.php.


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