PocketMine-MP 5.16.1 git-585aee9386a787c95e73dd0a05ffca8329606b68
pocketmine\data\bedrock\block\BlockStateData Class Reference
+ Collaboration diagram for pocketmine\data\bedrock\block\BlockStateData:

Public Member Functions

 __construct (private string $name, private array $states, private int $version)
 
 equals (self $that)
 
 getName ()
 
 getState (string $name)
 
 getStates ()
 
 getVersion ()
 
 getVersionAsString ()
 
 toNbt ()
 
 toVanillaNbt ()
 

Static Public Member Functions

static current (string $name, array $states)
 
static fromNbt (CompoundTag $nbt)
 

Public Attributes

const CURRENT_VERSION
 
const TAG_NAME = "name"
 
const TAG_STATES = "states"
 
const TAG_VERSION = "version"
 

Detailed Description

Contains the common information found in a serialized blockstate.

Definition at line 38 of file BlockStateData.php.

Constructor & Destructor Documentation

◆ __construct()

pocketmine\data\bedrock\block\BlockStateData::__construct ( private string  $name,
private array  $states,
private int  $version 
)
Parameters
Tag[]$states@phpstan-param array<string, Tag> $states

Definition at line 56 of file BlockStateData.php.

Member Function Documentation

◆ current()

static pocketmine\data\bedrock\block\BlockStateData::current ( string  $name,
array  $states 
)
static
Parameters
Tag[]$states@phpstan-param array<string, Tag> $states

Definition at line 66 of file BlockStateData.php.

◆ equals()

pocketmine\data\bedrock\block\BlockStateData::equals ( self  $that)

Definition at line 137 of file BlockStateData.php.

◆ fromNbt()

static pocketmine\data\bedrock\block\BlockStateData::fromNbt ( CompoundTag  $nbt)
static
Exceptions
BlockStateDeserializeException

Definition at line 95 of file BlockStateData.php.

◆ getName()

pocketmine\data\bedrock\block\BlockStateData::getName ( )

Definition at line 70 of file BlockStateData.php.

◆ getState()

pocketmine\data\bedrock\block\BlockStateData::getState ( string  $name)

Definition at line 78 of file BlockStateData.php.

◆ getStates()

pocketmine\data\bedrock\block\BlockStateData::getStates ( )
Returns
Tag[] @phpstan-return array<string, Tag>

Definition at line 76 of file BlockStateData.php.

Referenced by pocketmine\network\mcpe\convert\BlockStateDictionary\lookupStateIdFromData().

+ Here is the caller graph for this function:

◆ getVersion()

pocketmine\data\bedrock\block\BlockStateData::getVersion ( )

Definition at line 82 of file BlockStateData.php.

◆ getVersionAsString()

pocketmine\data\bedrock\block\BlockStateData::getVersionAsString ( )

Definition at line 84 of file BlockStateData.php.

◆ toNbt()

pocketmine\data\bedrock\block\BlockStateData::toNbt ( )

Encodes the blockstate as a TAG_Compound, but with extra PM-specific metadata, used for fixing bugs in old saved data. This should be used for anything saved to disk.

Definition at line 132 of file BlockStateData.php.

◆ toVanillaNbt()

pocketmine\data\bedrock\block\BlockStateData::toVanillaNbt ( )

Encodes the blockstate as a TAG_Compound, exactly as it would be in vanilla Bedrock.

Definition at line 117 of file BlockStateData.php.

References pocketmine\nbt\tag\CompoundTag\setTag().

+ Here is the call graph for this function:

Member Data Documentation

◆ CURRENT_VERSION

const pocketmine\data\bedrock\block\BlockStateData::CURRENT_VERSION
Initial value:
=
(1 << 24) |
(21 << 16) |
(0 << 8) |
(3)

Bedrock version of the most recent backwards-incompatible change to blockstates.

Definition at line 42 of file BlockStateData.php.

◆ TAG_NAME

const pocketmine\data\bedrock\block\BlockStateData::TAG_NAME = "name"

Definition at line 48 of file BlockStateData.php.

◆ TAG_STATES

const pocketmine\data\bedrock\block\BlockStateData::TAG_STATES = "states"

Definition at line 49 of file BlockStateData.php.

◆ TAG_VERSION

const pocketmine\data\bedrock\block\BlockStateData::TAG_VERSION = "version"

Definition at line 50 of file BlockStateData.php.


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