@ascentbv/ts-common - v1.0.123
    Preparing search index...

    Class BlockPistonComponent

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

    Hierarchy (View Summary)

    Index

    Properties

    block isMoving state componentId isValid typeId

    Methods

    getAttachedBlocks getAttachedBlocksLocations

    Properties

    block: Block

    Block instance that this component pertains to.

    isMoving: boolean

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

    This property can throw when used.

    state: BlockPistonState

    The current state of the piston.

    This property can throw when used.

    componentId: "minecraft:piston" = 'minecraft:piston'
    isValid: boolean

    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.

    typeId: string

    Identifier of the component.

    Methods

    • Returns Block[]

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

      This function can throw errors.

    • Returns Vector3[]

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

      This function can throw errors.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods