Class BlockPistonComponentBeta

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

Hierarchy

Constructors

constructor

Properties

block isExpanded isExpanding isMoving isRetracted isRetracting typeId componentId

Methods

getAttachedBlocks isValid

Constructors

Private constructor

Properties

Readonly block

block: Block

Remarks

Block instance that this component pertains to.

Readonly isExpanded

isExpanded: boolean

Remarks

Whether the piston is fully expanded.

Throws

This property can throw when used.

Readonly isExpanding

isExpanding: boolean

Remarks

Whether the piston is in the process of expanding.

Throws

This property can throw when used.

Readonly isMoving

isMoving: boolean

Remarks

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

Throws

This property can throw when used.

Readonly isRetracted

isRetracted: boolean

Remarks

Whether the piston is fully retracted.

Throws

This property can throw when used.

Readonly isRetracting

isRetracting: boolean

Remarks

Whether the piston is in the process of retracting.

Throws

This property can throw when used.

Readonly typeId

typeId: string

Remarks

Identifier of the component.

Static Readonly componentId

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

Methods

getAttachedBlocks

  • Returns Vector3[]

    Remarks

    Retrieves a set of blocks that this piston is connected with.

    Throws

    This function can throw errors.

isValid

  • Returns boolean

    Whether the component is valid.

    Remarks

    Returns whether the component is valid. A component is considered valid if its owner is valid, in addition to any addition to any additional validation required by the component.

Settings

Member Visibility

Theme

On This Page