OrientedPiece 5.46.0

abstract class · pocketmine\world\generator\vanilla\structure\piece\OrientedPiece · source

Extends StructurePiece

A piece built by code in piece-local coordinates, rotated and mirrored by its orientation (vanilla's StructurePiece helpers: getWorldX/Y/Z, placeBlock, generateBox, fillColumnDown, createChest...).

Properties

$mirror protected

protected int $mirror

$orientation protected

protected ?int $orientation

$rotation protected

protected int $rotation

Methods

canBeReplaced() protected

protected function canBeReplaced(\pocketmine\world\generator\vanilla\structure\StructurePlaceContext $c, int $x, int $y, int $z, \pocketmine\world\generator\vanilla\structure\BoundingBox $box) : bool

StructurePiece.canBeReplaced(): whether placeBlock() may replace the block at a piece-local position.

createChest() protected

protected function createChest(\pocketmine\world\generator\vanilla\structure\StructurePlaceContext $c, \pocketmine\world\generator\vanilla\structure\BoundingBox $box, \pocketmine\world\generator\vanilla\feature\FeatureRandom $random, int $x, int $y, int $z, string $lootTable, ?int $state = null) : bool

StructurePiece.createChest() at piece-local coordinates.

createChestAt()

public static function createChestAt(\pocketmine\world\generator\vanilla\structure\StructurePlaceContext $c, \pocketmine\world\generator\vanilla\structure\BoundingBox $box, \pocketmine\world\generator\vanilla\feature\FeatureRandom $random, int $x, int $y, int $z, string $lootTable, ?int $state = null) : bool

StructurePiece.createChest() at world coordinates.

createDispenser() protected

protected function createDispenser(\pocketmine\world\generator\vanilla\structure\StructurePlaceContext $c, \pocketmine\world\generator\vanilla\structure\BoundingBox $box, \pocketmine\world\generator\vanilla\feature\FeatureRandom $random, int $x, int $y, int $z, int $facing, string $lootTable) : bool

StructurePiece.createDispenser()

fillColumnDown() protected

protected function fillColumnDown(\pocketmine\world\generator\vanilla\structure\StructurePlaceContext $c, int $state, int $x, int $y, int $z, \pocketmine\world\generator\vanilla\structure\BoundingBox $box) : void

generateAirBox() protected

protected function generateAirBox(\pocketmine\world\generator\vanilla\structure\StructurePlaceContext $c, \pocketmine\world\generator\vanilla\structure\BoundingBox $box, int $minX, int $minY, int $minZ, int $maxX, int $maxY, int $maxZ) : void

generateAirBox()

generateBox() protected

protected function generateBox(\pocketmine\world\generator\vanilla\structure\StructurePlaceContext $c, \pocketmine\world\generator\vanilla\structure\BoundingBox $box, int $minX, int $minY, int $minZ, int $maxX, int $maxY, int $maxZ, int $edge, int $fill, bool $skipAir) : void

generateBoxWithSelector() protected

protected function generateBoxWithSelector(\pocketmine\world\generator\vanilla\structure\StructurePlaceContext $c, \pocketmine\world\generator\vanilla\structure\BoundingBox $box, int $minX, int $minY, int $minZ, int $maxX, int $maxY, int $maxZ, bool $skipAir, \pocketmine\world\generator\vanilla\feature\FeatureRandom $random, \pocketmine\world\generator\vanilla\structure\piece\BlockSelector $select …

generateBox() with a BlockSelector.

generateMaybeBox() protected

protected function generateMaybeBox(\pocketmine\world\generator\vanilla\structure\StructurePlaceContext $c, \pocketmine\world\generator\vanilla\structure\BoundingBox $box, \pocketmine\world\generator\vanilla\feature\FeatureRandom $random, float $probability, int $minX, int $minY, int $minZ, int $maxX, int $maxY, int $maxZ, int $edge, int $fill, bool $requireNonAir, bool $requireSkylight) : void

generateMaybeBox(): like generateBox, each block placed with a probability; $requireNonAir skips air blocks, $requireSkylight (vanilla hasToBeInside) skips blocks that are not interior (isInterior()).

generateUpperHalfSphere() protected

protected function generateUpperHalfSphere(\pocketmine\world\generator\vanilla\structure\StructurePlaceContext $c, \pocketmine\world\generator\vanilla\structure\BoundingBox $box, int $x0, int $y0, int $z0, int $x1, int $y1, int $z1, int $state, bool $skipAir) : void

generateUpperHalfSphere() (float maths like vanilla)

getBlock() protected

protected function getBlock(\pocketmine\world\generator\vanilla\structure\StructurePlaceContext $c, int $x, int $y, int $z, \pocketmine\world\generator\vanilla\structure\BoundingBox $box) : int

getOrientation()

public function getOrientation() : ?int

getWorldPos() protected

protected function getWorldPos(int $x, int $y, int $z) : array

getWorldX() protected

protected function getWorldX(int $x, int $z) : int

getWorldY() protected

protected function getWorldY(int $y) : int

getWorldZ() protected

protected function getWorldZ(int $x, int $z) : int

isInterior() protected

protected function isInterior(\pocketmine\world\generator\vanilla\structure\StructurePlaceContext $c, int $x, int $y, int $z, \pocketmine\world\generator\vanilla\structure\BoundingBox $box) : bool

StructurePiece.isInterior(): whether the block above the piece-local position is below the ocean floor heightmap (only inside the chunk box).

isReplaceableByStructures() protected

protected static function isReplaceableByStructures(\pocketmine\world\generator\vanilla\feature\block\JavaBlocks $blocks, int $state) : bool

StructurePiece.isReplaceableByStructures()

makeBoundingBox()

public static function makeBoundingBox(int $x, int $y, int $z, int $direction, int $width, int $height, int $depth) : \pocketmine\world\generator\vanilla\structure\BoundingBox

StructurePiece.makeBoundingBox()

maybeGenerateBlock() protected

protected function maybeGenerateBlock(\pocketmine\world\generator\vanilla\structure\StructurePlaceContext $c, \pocketmine\world\generator\vanilla\structure\BoundingBox $box, \pocketmine\world\generator\vanilla\feature\FeatureRandom $random, float $probability, int $x, int $y, int $z, int $state) : void

placeBlock() protected

protected function placeBlock(\pocketmine\world\generator\vanilla\structure\StructurePlaceContext $c, int $state, int $x, int $y, int $z, \pocketmine\world\generator\vanilla\structure\BoundingBox $box) : void

placeSpawner() protected

protected function placeSpawner(\pocketmine\world\generator\vanilla\structure\StructurePlaceContext $c, \pocketmine\world\generator\vanilla\structure\BoundingBox $box, int $x, int $y, int $z, string $javaEntity) : void

Places a mob spawner of the given Java entity at a piece-local position (placeBlock + SpawnerBlockEntity .setEntityId(), which consumes no randomness).

randomHorizontalDirection()

public static function randomHorizontalDirection(\pocketmine\world\generator\vanilla\random\LegacyRandom|\pocketmine\world\generator\vanilla\feature\FeatureRandom $random) : int

Direction.Plane.HORIZONTAL.getRandomDirection(random): N, E, S, W.

reorient() protected

protected static function reorient(\pocketmine\world\generator\vanilla\structure\StructurePlaceContext $c, int $x, int $y, int $z, int $state) : int

StructurePiece.reorient(): a chest facing away from the only solid neighbour.

setOrientation() protected

protected function setOrientation(?int $direction) : void

spawnMob() protected

protected function spawnMob(\pocketmine\world\generator\vanilla\structure\StructurePlaceContext $c, \pocketmine\world\generator\vanilla\structure\BoundingBox $box, string $javaEntity, int $x, int $y, int $z) : bool

Spawns a mob at the centre of a piece-local block, if the block is in the box.

state() protected

protected function state(\pocketmine\world\generator\vanilla\structure\StructurePlaceContext $c, string $state) : int