Class BlockStructureTrait

Hierarchy (View Summary)

BlockTrait
- BlockStructureTrait

Constructors

constructor

new BlockStructureTrait(
block: Block,
_options?: JSONLikeObject,
): BlockStructureTrait
Creates a new instance of the block trait.
Parameters
- block: Block
  The block that this trait will be attached to.
- Optional_options: JSONLikeObject
Returns BlockStructureTrait
Inherited from BlockTrait.constructor
- Defined in packages/core/src/block/traits/trait.ts:70

Properties

`Protected` `Readonly`block

block: Block

The block that this trait is attached to.

`Readonly`component

component: null | typeof BlockTypeComponent = ...

The block component that this trait is attached to.

`Protected` `Readonly`dimension

dimension: Dimension

The dimension that the block is in.

`Readonly`identifier

identifier: string = ...

The identifier of the trait.

`Readonly`state

state: null | string = ...

The block state key that this trait is attached to.

`Readonly`tag

tag: null | string = ...

The block tag that this trait is attached to.

`Static` `Readonly`component

component: null | typeof BlockTypeComponent = null

The block component that this trait is compatible with by default. If null, the trait will not attach to any block by default.

`Static` `Readonly`identifier

identifier: "structure_block"

The identifier of the trait.

`Static` `Readonly`state

state: null | string = null

The block state key that this trait is compatible with by default. If null, the trait will not be initialized by any block state.

`Static` `Readonly`tag

tag: null | string = null

The block tag that this trait is compatible with by default. If null, the trait will not attach to any block by default.

`Static` `Readonly`types

types: BlockIdentifier[] = ...

The block type identifiers that this trait is compatible with by default.

Methods

clone

clone(..._arguments: unknown[]): Trait
Clones the trait with the specified arguments.
Parameters
- ..._arguments: unknown[]
Returns Trait
Inherited from BlockTrait.clone
- Defined in packages/core/src/trait.ts:59

getBoundingBoxVisible

getBoundingBoxVisible(): boolean
Whether the bounding box of the structure is visible.

Returns boolean
True if the bounding box is visible, false otherwise.
- Defined in packages/core/src/block/traits/structure.ts:123

getMode

getMode(): number
Get the structure mode from the structure block.

Returns number
The mode of the structure block.
- Defined in packages/core/src/block/traits/structure.ts:34

getOffset

getOffset(): IPosition
Gets the structure offset from the block's NBT data.

Returns IPosition
The structure offset as an IPosition.
- Defined in packages/core/src/block/traits/structure.ts:98

getSize

getSize(): IPosition
Gets the structure size from the block's NBT data.

Returns IPosition
The structure size as an IPosition.
- Defined in packages/core/src/block/traits/structure.ts:73

getStructureName

getStructureName(): string
Get the structure name from the block's NBT data.

Returns string
The structure name or an empty string if not set.
- Defined in packages/core/src/block/traits/structure.ts:52

`Optional`onAdd

onAdd(): void
Called when the trait is added to an object.

Returns void
Inherited from BlockTrait.onAdd
- Defined in packages/core/src/trait.ts:42

`Optional`onBreak

onBreak(options: BlockDestroyOptions): boolean | void
Called when the block is broken in the world.
Parameters
- options: BlockDestroyOptions
Returns boolean | void
Whether the block break was successful; default is true.
Inherited from BlockTrait.onBreak
- Defined in packages/core/src/block/traits/trait.ts:96

`Optional`onContainerUpdate

onContainerUpdate(container: Container): void
Called when a container that is attached to the block is updated.
Parameters
- container: Container
  The container that was updated.
Returns void
Inherited from BlockTrait.onContainerUpdate
- Defined in packages/core/src/block/traits/trait.ts:128

onInteract

onInteract(options: BlockInteractionOptions): void
Called when the block is interacted with by a player.
Parameters
- options: BlockInteractionOptions
  The options of the block interaction.
Returns void
Whether the interaction was successful; default is true.
Overrides BlockTrait.onInteract
- Defined in packages/core/src/block/traits/structure.ts:18

`Optional`onPick

onPick(player: Player, withData: boolean): void
Called when a player pick blocks the block.
Parameters
- player: Player
  The player that picked the block.
- withData: boolean
  Whether the player picked the block with a data request.
Returns void
Inherited from BlockTrait.onPick
- Defined in packages/core/src/block/traits/trait.ts:122

`Optional`onPlace

onPlace(options: BlockPlacementOptions): boolean | void
Called when the block is placed in the world.
Parameters
- options: BlockPlacementOptions
  The options of the block placement.
Returns boolean | void
Whether the block placement was successful; default is true.
Inherited from BlockTrait.onPlace
- Defined in packages/core/src/block/traits/trait.ts:89

`Optional`onRemove

onRemove(): void
Called when the trait is removed from an object.

Returns void
Inherited from BlockTrait.onRemove
- Defined in packages/core/src/trait.ts:47

`Optional`onReplace

onReplace(): void
Returns void
Inherited from BlockTrait.onReplace
- Defined in packages/core/src/block/traits/trait.ts:130

`Optional`onStartBreak

onStartBreak(player: Player): boolean | void
Called when the block is started to be broken in the world.
Parameters
- player: Player
  The player that started to break the block.
Returns boolean | void
Inherited from BlockTrait.onStartBreak
- Defined in packages/core/src/block/traits/trait.ts:102

`Optional`onStopBreak

onStopBreak(player: Player): void
Called when the block is stopped to be broken in the world.
Parameters
- player: Player
  The player that stopped breaking the block.
Returns void
Inherited from BlockTrait.onStopBreak
- Defined in packages/core/src/block/traits/trait.ts:108

`Optional`onTick

onTick(details: TraitOnTickDetails): void
Called when the trait is ticked by the dimension.
Parameters
- details: TraitOnTickDetails
  The details about the tick event.
Returns void
Inherited from BlockTrait.onTick
- Defined in packages/core/src/trait.ts:53

`Optional`onUpdate

onUpdate(source?: Block): void
Called when the block is updated in the world.
Parameters
- Optionalsource: Block
  The source of the update, if any.
Returns void
Inherited from BlockTrait.onUpdate
- Defined in packages/core/src/block/traits/trait.ts:82

setBoundingBoxVisible

setBoundingBoxVisible(visible: boolean): void
Sets whether the bounding box of the structure is visible.
Parameters
- visible: boolean
  True to make the bounding box visible, false to hide it.
Returns void
- Defined in packages/core/src/block/traits/structure.ts:131

setMode

setMode(mode: number): void
Sets the mode of the structure block.
Parameters
- mode: number
  The mode to set for the structure block.
Returns void
- Defined in packages/core/src/block/traits/structure.ts:43

setOffset

setOffset(offset: IPosition): void
Sets the structure offset in the block's NBT data.
Parameters
- offset: IPosition
  The offset of the structure to set.
Returns void
- Defined in packages/core/src/block/traits/structure.ts:112

setSize

setSize(size: IPosition): void
Sets the structure size in the block's NBT data.
Parameters
- size: IPosition
  The size of the structure to set.
Returns void
- Defined in packages/core/src/block/traits/structure.ts:87

setStructureName

setStructureName(name: string): void
Sets the structure name in the block's NBT data.
Parameters
- name: string
  The name of the structure to set.
Returns void
- Defined in packages/core/src/block/traits/structure.ts:64

Class BlockStructureTrait

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BlockStructureTrait

Properties

Protected Readonlyblock

Readonlycomponent

Protected Readonlydimension

Readonlyidentifier

Readonlystate

Readonlytag

Static Readonlycomponent

Static Readonlyidentifier

Static Readonlystate

Static Readonlytag

Static Readonlytypes

Methods

clone

Parameters

Returns Trait

getBoundingBoxVisible

Returns boolean

getMode

Returns number

getOffset

Returns IPosition

getSize

Returns IPosition

getStructureName

Returns string

OptionalonAdd

Returns void

OptionalonBreak

Parameters

Returns boolean | void

OptionalonContainerUpdate

Parameters

Returns void

onInteract

Parameters

Returns void

OptionalonPick

Parameters

Returns void

OptionalonPlace

Parameters

Returns boolean | void

OptionalonRemove

Returns void

OptionalonReplace

Returns void

OptionalonStartBreak

Parameters

Returns boolean | void

OptionalonStopBreak

Parameters

Returns void

OptionalonTick

Parameters

Returns void

OptionalonUpdate

Parameters

Returns void

setBoundingBoxVisible

Parameters

Returns void

setMode

Parameters

Returns void

setOffset

Parameters

Returns void

setSize

Parameters

`Protected` `Readonly`block

`Readonly`component

`Protected` `Readonly`dimension

`Readonly`identifier

`Readonly`state

`Readonly`tag

`Static` `Readonly`component

`Static` `Readonly`identifier

`Static` `Readonly`state

`Static` `Readonly`tag

`Static` `Readonly`types

`Optional`onAdd

`Optional`onBreak

`Optional`onContainerUpdate

`Optional`onPick

`Optional`onPlace

`Optional`onRemove

`Optional`onReplace

`Optional`onStartBreak

`Optional`onStopBreak

`Optional`onTick

`Optional`onUpdate