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

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 (int $actorUniqueId, int $actorRuntimeId, int $playerGamemode, Vector3 $playerPosition, float $pitch, float $yaw, CacheableNbt $playerActorProperties, LevelSettings $levelSettings, string $levelId, string $worldName, string $premiumWorldTemplateId, bool $isTrial, PlayerMovementSettings $playerMovementSettings, int $currentTick, int $enchantmentSeed, string $multiplayerCorrelationId, bool $enableNewInventorySystem, string $serverSoftwareVersion, UuidInterface $worldTemplateId, bool $enableClientSideChunkGeneration, bool $blockNetworkIdsAreHashes, NetworkPermissions $networkPermissions, array $blockPalette, int $blockPaletteChecksum, array $itemTable,)
 

Public Attributes

int $actorRuntimeId
 
int $actorUniqueId
 
bool $blockNetworkIdsAreHashes = false
 
array $blockPalette = []
 
int $blockPaletteChecksum
 
int $currentTick = 0
 
bool $enableClientSideChunkGeneration
 
bool $enableNewInventorySystem = false
 
int $enchantmentSeed = 0
 
bool $isTrial = false
 
array $itemTable
 
string $levelId = ""
 
LevelSettings $levelSettings
 
string $multiplayerCorrelationId = ""
 
NetworkPermissions $networkPermissions
 
float $pitch
 
CacheableNbt $playerActorProperties
 
int $playerGamemode
 
PlayerMovementSettings $playerMovementSettings
 
Vector3 $playerPosition
 
string $premiumWorldTemplateId = ""
 
int $recipientSubId = 0
 
int $senderSubId = 0
 
string $serverSoftwareVersion
 
string $worldName
 
UuidInterface $worldTemplateId
 
float $yaw
 
const NETWORK_ID = ProtocolInfo::START_GAME_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 29 of file StartGamePacket.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\StartGamePacket::create ( int  $actorUniqueId,
int  $actorRuntimeId,
int  $playerGamemode,
Vector3  $playerPosition,
float  $pitch,
float  $yaw,
CacheableNbt  $playerActorProperties,
LevelSettings  $levelSettings,
string  $levelId,
string  $worldName,
string  $premiumWorldTemplateId,
bool  $isTrial,
PlayerMovementSettings  $playerMovementSettings,
int  $currentTick,
int  $enchantmentSeed,
string  $multiplayerCorrelationId,
bool  $enableNewInventorySystem,
string  $serverSoftwareVersion,
UuidInterface  $worldTemplateId,
bool  $enableClientSideChunkGeneration,
bool  $blockNetworkIdsAreHashes,
NetworkPermissions  $networkPermissions,
array  $blockPalette,
int  $blockPaletteChecksum,
array  $itemTable 
)
static

@generate-create-func

Parameters
BlockPaletteEntry[]$blockPalette
ItemTypeEntry[]$itemTable@phpstan-param CacheableNbt<CompoundTag> $playerActorProperties @phpstan-param list<BlockPaletteEntry> $blockPalette @phpstan-param list<ItemTypeEntry> $itemTable

Definition at line 88 of file StartGamePacket.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\StartGamePacket::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 144 of file StartGamePacket.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\StartGamePacket::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 192 of file StartGamePacket.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\StartGamePacket::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 237 of file StartGamePacket.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

◆ $actorRuntimeId

int pocketmine\network\mcpe\protocol\StartGamePacket::$actorRuntimeId

Definition at line 33 of file StartGamePacket.php.

◆ $actorUniqueId

int pocketmine\network\mcpe\protocol\StartGamePacket::$actorUniqueId

Definition at line 32 of file StartGamePacket.php.

◆ $blockNetworkIdsAreHashes

bool pocketmine\network\mcpe\protocol\StartGamePacket::$blockNetworkIdsAreHashes = false

Definition at line 58 of file StartGamePacket.php.

◆ $blockPalette

array pocketmine\network\mcpe\protocol\StartGamePacket::$blockPalette = []

Definition at line 65 of file StartGamePacket.php.

◆ $blockPaletteChecksum

int pocketmine\network\mcpe\protocol\StartGamePacket::$blockPaletteChecksum

Checksum of the full block palette. This is a hash of some weird stringified version of the NBT. This is used along with the baseGameVersion to check for inconsistencies in the block palette. Fill with 0 if you don't want to bother having the client verify the palette (seems pointless anyway).

Definition at line 72 of file StartGamePacket.php.

◆ $currentTick

int pocketmine\network\mcpe\protocol\StartGamePacket::$currentTick = 0

Definition at line 51 of file StartGamePacket.php.

◆ $enableClientSideChunkGeneration

bool pocketmine\network\mcpe\protocol\StartGamePacket::$enableClientSideChunkGeneration

Definition at line 57 of file StartGamePacket.php.

◆ $enableNewInventorySystem

bool pocketmine\network\mcpe\protocol\StartGamePacket::$enableNewInventorySystem = false

Definition at line 54 of file StartGamePacket.php.

◆ $enchantmentSeed

int pocketmine\network\mcpe\protocol\StartGamePacket::$enchantmentSeed = 0

Definition at line 52 of file StartGamePacket.php.

◆ $isTrial

bool pocketmine\network\mcpe\protocol\StartGamePacket::$isTrial = false

Definition at line 49 of file StartGamePacket.php.

◆ $itemTable

array pocketmine\network\mcpe\protocol\StartGamePacket::$itemTable

Definition at line 78 of file StartGamePacket.php.

◆ $levelId

string pocketmine\network\mcpe\protocol\StartGamePacket::$levelId = ""

Definition at line 46 of file StartGamePacket.php.

◆ $levelSettings

LevelSettings pocketmine\network\mcpe\protocol\StartGamePacket::$levelSettings

Definition at line 44 of file StartGamePacket.php.

◆ $multiplayerCorrelationId

string pocketmine\network\mcpe\protocol\StartGamePacket::$multiplayerCorrelationId = ""

Definition at line 53 of file StartGamePacket.php.

◆ $networkPermissions

NetworkPermissions pocketmine\network\mcpe\protocol\StartGamePacket::$networkPermissions

Definition at line 59 of file StartGamePacket.php.

◆ $pitch

float pocketmine\network\mcpe\protocol\StartGamePacket::$pitch

Definition at line 38 of file StartGamePacket.php.

◆ $playerActorProperties

CacheableNbt pocketmine\network\mcpe\protocol\StartGamePacket::$playerActorProperties

@phpstan-var CacheableNbt<CompoundTag>

Definition at line 42 of file StartGamePacket.php.

◆ $playerGamemode

int pocketmine\network\mcpe\protocol\StartGamePacket::$playerGamemode

Definition at line 34 of file StartGamePacket.php.

◆ $playerMovementSettings

PlayerMovementSettings pocketmine\network\mcpe\protocol\StartGamePacket::$playerMovementSettings

Definition at line 50 of file StartGamePacket.php.

◆ $playerPosition

Vector3 pocketmine\network\mcpe\protocol\StartGamePacket::$playerPosition

Definition at line 36 of file StartGamePacket.php.

◆ $premiumWorldTemplateId

string pocketmine\network\mcpe\protocol\StartGamePacket::$premiumWorldTemplateId = ""

Definition at line 48 of file StartGamePacket.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.

◆ $serverSoftwareVersion

string pocketmine\network\mcpe\protocol\StartGamePacket::$serverSoftwareVersion

Definition at line 55 of file StartGamePacket.php.

◆ $worldName

string pocketmine\network\mcpe\protocol\StartGamePacket::$worldName

Definition at line 47 of file StartGamePacket.php.

◆ $worldTemplateId

UuidInterface pocketmine\network\mcpe\protocol\StartGamePacket::$worldTemplateId

Definition at line 56 of file StartGamePacket.php.

◆ $yaw

float pocketmine\network\mcpe\protocol\StartGamePacket::$yaw

Definition at line 39 of file StartGamePacket.php.

◆ NETWORK_ID

const pocketmine\network\mcpe\protocol\StartGamePacket::NETWORK_ID = ProtocolInfo::START_GAME_PACKET

Definition at line 30 of file StartGamePacket.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: