Class BlockPermutationUpdateSignal

Hierarchy (View Summary)

EventSignal
- BlockPermutationUpdateSignal

Index

Constructors

Properties

dimension identifier permutation position world identifier

Accessors

Methods

Constructors

constructor

new BlockPermutationUpdateSignal(
    dimension: Dimension,
    position: BlockPosition,
    permutation: BlockPermutation,
): BlockPermutationUpdateSignal
Creates a new block permutation update signal.
Parameters
- dimension: Dimension
  The dimension the event occurred in.
- position: BlockPosition
  The position of the block.
- permutation: BlockPermutation
  The permutation that is being set to the block.
Returns BlockPermutationUpdateSignal
Overrides EventSignal.constructor
- Defined in packages/core/src/events/block-permutation-update.ts:33

Properties

`Readonly`dimension

dimension: Dimension

The dimension the event occurred in.

`Readonly`identifier

identifier: WorldEvent = ...

The identifier of the signal.

`Readonly`permutation

permutation: BlockPermutation

The permutation that is being set to the block.

`Readonly`position

position: BlockPosition

The position of the block.

`Readonly`world

world: World

The world instance the signal was emitted in.

`Static` `Readonly`identifier

identifier: BlockPermutationUpdate = WorldEvent.BlockPermutationUpdate

The identifier of the signal.

Accessors

block

get block(): Block
The block that was updated.

Returns Block
- Defined in packages/core/src/events/block-permutation-update.ts:47

Methods

emit

emit(): boolean
Emits the signal instance.

Returns boolean
Whether the signal was emitted successfully; default is true.
Inherited from EventSignal.emit
- Defined in packages/core/src/events/event-signal.ts:34