Class BlockTrait

Hierarchy (View Summary)

Trait
- BlockTrait

Index

Constructors

constructor

new BlockTrait(block: Block, _options?: JSONLikeObject): BlockTrait
Creates a new instance of the block trait.
Parameters
- block: Block
  The block that this trait will be attached to.
- Optional_options: JSONLikeObject
Returns BlockTrait
Overrides Trait.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: string

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: string[] = []

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 Trait.clone
- Defined in packages/core/src/trait.ts:69

`Optional`onAdd

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

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

`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.
- 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
- Defined in packages/core/src/block/traits/trait.ts:128

`Optional`onInteract

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

`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
- 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.
- Defined in packages/core/src/block/traits/trait.ts:89

`Optional`onRandomTick

onRandomTick(): void
Called when the trait is random ticked by the dimension.

Returns void
Inherited from Trait.onRandomTick
- Defined in packages/core/src/trait.ts:63

`Optional`onRemove

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

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

`Optional`onReplace

onReplace(): void
Returns void
- 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
- 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
- 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 Trait.onTick
- Defined in packages/core/src/trait.ts:58

`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
- Defined in packages/core/src/block/traits/trait.ts:82

setRandomTickProbability

setRandomTickProbability(numerator: number, denominator: number): void
Sets the probability of this trait being randomly ticked each tick.
Parameters
- numerator: number
  The numerator of the probability fraction.
- denominator: number
  The denominator of the probability fraction.
Returns void
Inherited from Trait.setRandomTickProbability
- Defined in packages/core/src/trait.ts:102

shouldRandomTick

shouldRandomTick(factor?: number): boolean
Wether this trait should be randomly ticked this tick.
Parameters
- factor: number = 1
  A factor to multiply the chance by. Default is 1.
Returns boolean
True if the trait should be randomly ticked, false otherwise.
Inherited from Trait.shouldRandomTick
- Defined in packages/core/src/trait.ts:78

Class BlockTrait

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BlockTrait

Properties

Protected Readonlyblock

Readonlycomponent

Protected Readonlydimension

Readonlyidentifier

Readonlystate

Readonlytag

Static Readonlycomponent

Static Readonlyidentifier

Static Readonlystate

Static Readonlytag

Static Readonlytypes

Methods

clone

Parameters

Returns Trait

OptionalonAdd

Returns void

OptionalonBreak

Parameters

Returns boolean | void

OptionalonContainerUpdate

Parameters

Returns void

OptionalonInteract

Parameters

Returns boolean | void

OptionalonPick

Parameters

Returns void

OptionalonPlace

Parameters

Returns boolean | void

OptionalonRandomTick

Returns void

OptionalonRemove

Returns void

OptionalonReplace

Returns void

OptionalonStartBreak

Parameters

Returns boolean | void

OptionalonStopBreak

Parameters

Returns void

OptionalonTick

Parameters

Returns void

OptionalonUpdate

Parameters

Returns void

setRandomTickProbability

Parameters

Returns void

shouldRandomTick

Parameters

Returns boolean

Settings

On This Page

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

`Optional`onPick

`Optional`onPlace

`Optional`onRandomTick

`Optional`onRemove

`Optional`onReplace

`Optional`onStartBreak

`Optional`onStopBreak

`Optional`onTick

`Optional`onUpdate