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

`Private`constructor

new BlockPistonComponent(): BlockPistonComponent
Beta
Returns BlockPistonComponent
Overrides BlockComponent.constructor
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server/index.d.ts:4311

Properties

`Readonly` `Beta`block

block: Block

Remarks

Block instance that this component pertains to.

`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`state

state: BlockPistonState

Remarks

The current state of the piston.

Throws

This property can throw when used.

`Readonly` `Beta`typeId

typeId: string

Remarks

Identifier of the component.

`Static` `Readonly` `Beta`componentId

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

Methods

getAttachedBlocks

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

Throws
This function can throw errors.
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server/index.d.ts:4335

getAttachedBlocksLocations

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

Throws
This function can throw errors.
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server/index.d.ts:4343

isValid

isValid(): boolean
Beta
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.
Inherited from BlockComponent.isValid
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server/index.d.ts:5352

Class BlockPistonComponent`Beta`

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

`Private`constructor

Returns BlockPistonComponent

Properties

`Readonly` `Beta`block

Remarks

`Readonly` `Beta`isMoving

Remarks

Throws

`Readonly` `Beta`state

Remarks

Throws

`Readonly` `Beta`typeId

Remarks

`Static` `Readonly` `Beta`componentId

Methods

getAttachedBlocks

Returns Block[]

Remarks

Throws

getAttachedBlocksLocations

Returns Vector3[]

Remarks

Throws

isValid

Returns boolean

Remarks

Settings

On This Page

Class BlockPistonComponentBeta

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

Privateconstructor

Returns BlockPistonComponent

Properties

Readonly Betablock

Remarks

Readonly BetaisMoving

Remarks

Throws

Readonly Betastate

Remarks

Throws

Readonly BetatypeId

Remarks

Static Readonly BetacomponentId

Methods

getAttachedBlocks

Returns Block[]

Remarks

Throws

getAttachedBlocksLocations

Returns Vector3[]

Remarks

Throws

isValid

Returns boolean

Remarks

Settings

On This Page

Class BlockPistonComponent`Beta`

`Private`constructor

`Readonly` `Beta`block

`Readonly` `Beta`isMoving

`Readonly` `Beta`state

`Readonly` `Beta`typeId

`Static` `Readonly` `Beta`componentId