Class BlockPistonComponent

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

Hierarchy

Constructors

constructor

Properties

attachedBlocks isExpanded isExpanding isMoving isRetracted isRetracting location typeId componentId

Constructors

Protected constructor

Properties

Readonly attachedBlocks

attachedBlocks: BlockLocation[]

A set of locations for blocks that are impacted by the activation of this piston.

Throws

This property can throw when used.

Readonly isExpanded

isExpanded: boolean

Whether the piston is fully expanded.

Throws

This property can throw when used.

Readonly isExpanding

isExpanding: boolean

Whether the piston is in the process of expanding.

Throws

This property can throw when used.

Readonly isMoving

isMoving: boolean

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

Throws

This property can throw when used.

Readonly isRetracted

isRetracted: boolean

Whether the piston is fully retracted.

Throws

This property can throw when used.

Readonly isRetracting

isRetracting: boolean

Whether the piston is in the process of retracting.

Throws

This property can throw when used.

Readonly location

location: BlockLocation

Source location of the block.

Readonly typeId

typeId: string

Identifier of this component.

Static Readonly componentId

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

Identifier of this component.

Settings

Member Visibility

Theme

On This Page