Inheritance diagram for pocketmine\data\runtime\RuntimeDataDescriber: Collaboration diagram for pocketmine\data\runtime\RuntimeDataDescriber:Public Member Functions | |
| axis (int &$axis) | |
| bool (bool &$value) | |
| boundedIntAuto (int $min, int $max, int &$value) | |
| enum (\UnitEnum &$case) | |
| enumSet (array &$set, array $allCases) | |
| facing (int &$facing) | |
| facingExcept (int &$facing, int $except) | |
| facingFlags (array &$faces) | |
| horizontalAxis (int &$axis) | |
| horizontalFacing (int &$facing) | |
| horizontalFacingFlags (array &$faces) | |
| int (int $bits, int &$value) | |
| railShape (int &$railShape) | |
| straightOnlyRailShape (int &$railShape) | |
| 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 37 of file RuntimeDataDescriber.php.
Member Function Documentation
◆ 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.
◆ enum()
| pocketmine\data\runtime\RuntimeDataDescriber::enum | ( | \UnitEnum & | $case | ) |
@phpstan-template T of \UnitEnum @phpstan-param T &$case @phpstan-param-out T $case
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 | ) |
- Parameters
-
int[] $faces
Implemented in pocketmine\data\runtime\RuntimeDataReader, pocketmine\data\runtime\RuntimeDataSizeCalculator, and pocketmine\data\runtime\RuntimeDataWriter.
◆ horizontalFacingFlags()
| pocketmine\data\runtime\RuntimeDataDescriber::horizontalFacingFlags | ( | array & | $faces | ) |
- Parameters
-
int[] $faces
Implemented in pocketmine\data\runtime\RuntimeDataReader, pocketmine\data\runtime\RuntimeDataSizeCalculator, and pocketmine\data\runtime\RuntimeDataWriter.
◆ 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:
