Class BlockPistonComponent`Beta`

When present, this block has piston-like behavior. Contains additional properties for discovering block piston state.

Hierarchy (View Summary)

BlockComponent
- BlockPistonComponent

Index

Constructors

Properties

block isExpanded isExpanding isMoving isRetracted isRetracting typeId componentId

Methods

getAttachedBlocks

Constructors

`Protected`constructor

new BlockPistonComponent(): BlockPistonComponent
Beta
Returns BlockPistonComponent
Overrides BlockComponent.constructor

Properties

`Readonly` `Beta`block

block: Block

Remarks

Block instance that this component pertains to.

`Readonly` `Beta`isExpanded

isExpanded: boolean

Remarks

Whether the piston is fully expanded.

Throws

This property can throw when used.

`Readonly` `Beta`isExpanding

isExpanding: boolean

Remarks

Whether the piston is in the process of expanding.

Throws

This property can throw when used.

`Readonly` `Beta`isMoving

isMoving: boolean

Remarks

Whether the piston is in the process of expanding or retracting.

Throws

This property can throw when used.

`Readonly` `Beta`isRetracted

isRetracted: boolean

Remarks

Whether the piston is fully retracted.

Throws

This property can throw when used.

`Readonly` `Beta`isRetracting

isRetracting: boolean

Remarks

Whether the piston is in the process of retracting.

Throws

This property can throw when used.

`Readonly` `Beta`typeId

typeId: string

`Static` `Readonly` `Beta`componentId

componentId: "minecraft:piston" = 'minecraft:piston'

Remarks

Identifier of this component.

Methods

getAttachedBlocks

getAttachedBlocks(): Vector3[]
Beta
Returns Vector3[]
Remarks
Retrieves a set of blocks that this piston is connected with.

This function can't be called in read-only mode.

Throws
This function can throw errors.