Class BlockPistonComponent

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

Hierarchy

Constructors

constructor

Properties

block isMoving state typeId componentId

Methods

getAttachedBlocks getAttachedBlocksLocations isValid

Constructors

Private constructor

Properties

Readonly block

block: Block

Remarks

Block instance that this component pertains to.

Readonly isMoving

isMoving: boolean

Remarks

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

Throws

This property can throw when used.

Readonly state

state: BlockPistonState

Remarks

The current state of the piston.

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 Block[]

    Remarks

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

    Throws

    This function can throw errors.

getAttachedBlocksLocations

  • Returns Vector3[]

    Remarks

    Retrieves a set of block locations that this piston is connected with.

    Throws

    This function can throw errors.

isValid

  • Returns boolean

    Whether the component is valid.

    Deprecated

    This function is deprecated and will be removed in 2.0.0.

    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