PistonArm 5.46.0

class · pocketmine\block\tile\PistonArm · source

Extends Spawnable

Block entity of pistons and sticky pistons ("PistonArm" in Bedrock). It holds the movement state of the arm; the client animates the arm and the moving blocks from it.

NBT (Minecraft Wiki "Bedrock Edition level format/Block entity format", PowerNukkitX BlockEntityPistonArm, GeyserMC PistonBlockEntity): State/NewState (byte, 0 retracted, 1 extending, 2 extended, 3 retracting), Progress and LastProgress (float, 0.0/0.5/1.0), Sticky (byte), AttachedBlocks and BreakBlocks (list of int x, y, z triplets of the moved blocks' starting positions and of the destroyed blocks).

Constants

PROGRESS_STEP

public const PROGRESS_STEP = 0.5

Progress made by the arm each game tick (a move takes 2 game ticks).

STATE_EXTENDED

public const STATE_EXTENDED = 2

STATE_EXTENDING

public const STATE_EXTENDING = 1

STATE_RETRACTED

public const STATE_RETRACTED = 0

STATE_RETRACTING

public const STATE_RETRACTING = 3

Methods

addAdditionalSpawnData() protected

protected function addAdditionalSpawnData(\pocketmine\nbt\tag\CompoundTag $nbt) : void

broadcastState()

public function broadcastState() : void

Sends the arm's current state to the players who can see it, so that their clients animate it.

finishMove()

public function finishMove(bool $extended) : void

Ends the current movement (or forces the given resting state). LastProgress keeps the value of the last step, like vanilla, so that clients finish animating the last half of the movement.

getAttachedBlocks()

public function getAttachedBlocks() : array

Returns the starting positions of the blocks moved by the current movement.

getBreakBlocks()

public function getBreakBlocks() : array

getLastMoveTick()

public function getLastMoveTick() : int

getLastProgress()

public function getLastProgress() : float

getPendingPower()

public function getPendingPower() : ?bool

getProgress()

public function getProgress() : float

getState()

public function getState() : int

isExtending()

public function isExtending() : bool

isMoving()

public function isMoving() : bool

isSticky()

public function isSticky() : bool

readSaveData()

public function readSaveData(\pocketmine\nbt\tag\CompoundTag $nbt) : void

setLastMoveTick()

public function setLastMoveTick(int $tick) : void

setPendingPower()

public function setPendingPower(?bool $pendingPower) : void

setSticky()

public function setSticky(bool $sticky) : void

startMove()

public function startMove(bool $extending, array $attachedBlocks, array $breakBlocks) : void

Starts a movement: the arm's progress goes from 0 to 1 (extending) or 1 to 0 (retracting).

step()

public function step() : bool

Advances the arm by one game tick. Returns true once the arm reached the end of its movement.

writeSaveData() protected

protected function writeSaveData(\pocketmine\nbt\tag\CompoundTag $nbt) : void