PocketMine-MP 5.14.2 git-50e2c469a547a16a23b2dc691e70a51d34e29395
pocketmine\data\runtime\RuntimeDataDescriber Interface Reference
+ Inheritance diagram for pocketmine\data\runtime\RuntimeDataDescriber:
+ Collaboration diagram for pocketmine\data\runtime\RuntimeDataDescriber:

Public Member Functions

 axis (int &$axis)
 
 bellAttachmentType (\pocketmine\block\utils\BellAttachmentType &$value)
 
 bool (bool &$value)
 
 boundedInt (int $bits, int $min, int $max, int &$value)
 
 boundedIntAuto (int $min, int $max, int &$value)
 
 brewingStandSlots (array &$slots)
 
 copperOxidation (\pocketmine\block\utils\CopperOxidation &$value)
 
 coralType (\pocketmine\block\utils\CoralType &$value)
 
 dirtType (\pocketmine\block\utils\DirtType &$value)
 
 dripleafState (\pocketmine\block\utils\DripleafState &$value)
 
 dyeColor (\pocketmine\block\utils\DyeColor &$value)
 
 enum (\UnitEnum &$case)
 
 enumSet (array &$set, array $allCases)
 
 facing (int &$facing)
 
 facingExcept (int &$facing, int $except)
 
 facingFlags (array &$faces)
 
 froglightType (\pocketmine\block\utils\FroglightType &$value)
 
 horizontalAxis (int &$axis)
 
 horizontalFacing (int &$facing)
 
 horizontalFacingFlags (array &$faces)
 
 int (int $bits, int &$value)
 
 leverFacing (\pocketmine\block\utils\LeverFacing &$value)
 
 medicineType (\pocketmine\item\MedicineType &$value)
 
 mobHeadType (\pocketmine\block\utils\MobHeadType &$value)
 
 mushroomBlockType (\pocketmine\block\utils\MushroomBlockType &$value)
 
 potionType (\pocketmine\item\PotionType &$value)
 
 railShape (int &$railShape)
 
 slabType (\pocketmine\block\utils\SlabType &$value)
 
 straightOnlyRailShape (int &$railShape)
 
 suspiciousStewType (\pocketmine\item\SuspiciousStewType &$value)
 
 wallConnections (array &$connections)
 

Detailed Description

Interface implemented by RuntimeDataReader, RuntimeDataWriter and RuntimeDataSizeCalculator. Used to describe the structure of runtime data to an implementation.

This interface should be considered sealed. You may use it as a type for parameters and return values, but it should not be implemented outside of this package. New methods may be added without warning.

Definition at line 38 of file RuntimeDataDescriber.php.

Member Function Documentation

◆ boundedInt()

pocketmine\data\runtime\RuntimeDataDescriber::boundedInt ( int  $bits,
int  $min,
int  $max,
int &  $value 
)

◆ boundedIntAuto()

pocketmine\data\runtime\RuntimeDataDescriber::boundedIntAuto ( int  $min,
int  $max,
int &  $value 
)

Same as boundedInt() but automatically calculates the required number of bits from the range. The range bounds must be constant.

Implemented in pocketmine\data\runtime\RuntimeDataReader, pocketmine\data\runtime\RuntimeDataSizeCalculator, and pocketmine\data\runtime\RuntimeDataWriter.

◆ brewingStandSlots()

pocketmine\data\runtime\RuntimeDataDescriber::brewingStandSlots ( array &  $slots)
Parameters
BrewingStandSlot[]$slots@phpstan-param array<int, BrewingStandSlot> $slots
Deprecated:
Use enumSet() instead.

Implemented in pocketmine\data\runtime\RuntimeDataReader, pocketmine\data\runtime\RuntimeDataSizeCalculator, and pocketmine\data\runtime\RuntimeDataWriter.

◆ enumSet()

pocketmine\data\runtime\RuntimeDataDescriber::enumSet ( array &  $set,
array  $allCases 
)
Parameters
\UnitEnum[]&$set
\UnitEnum[]$allCases

@phpstan-template T of \UnitEnum @phpstan-param array<int, T> &$set @phpstan-param array<int, T> $allCases

Implemented in pocketmine\data\runtime\RuntimeDataReader, pocketmine\data\runtime\RuntimeDataSizeCalculator, and pocketmine\data\runtime\RuntimeDataWriter.

◆ facingFlags()

pocketmine\data\runtime\RuntimeDataDescriber::facingFlags ( array &  $faces)

◆ horizontalFacingFlags()

pocketmine\data\runtime\RuntimeDataDescriber::horizontalFacingFlags ( array &  $faces)

◆ wallConnections()

pocketmine\data\runtime\RuntimeDataDescriber::wallConnections ( array &  $connections)
Parameters
WallConnectionType[]$connections@phpstan-param array<Facing::NORTH|Facing::EAST|Facing::SOUTH|Facing::WEST, WallConnectionType> $connections

Implemented in pocketmine\data\runtime\RuntimeDataReader, pocketmine\data\runtime\RuntimeDataSizeCalculator, and pocketmine\data\runtime\RuntimeDataWriter.


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