Class BlockButtonTrait

Hierarchy (View Summary)

BlockTrait
- BlockButtonTrait

Constructors

constructor

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

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.

releaseTick

releaseTick: bigint = -1n

The tick at which the button will be released.

`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: "button"

The identifier of the trait.

`Static` `Readonly`state

state: "button_pressed_bit"

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

`Protected`breakNextTick

breakNextTick(isSupported: () => boolean): void
Breaks the block on the next tick, dropping it, if it is still not held up then. Breaking a block updates its neighbours, so blocks held up by one another break one per tick, as in vanilla, rather than all at once, which spreads the work of breaking many blocks over many ticks.
Parameters
- isSupported: () => boolean
  Checks whether the block is held up.
Returns void
Inherited from BlockTrait.breakNextTick
- Defined in packages/core/src/block/traits/trait.ts:143

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:69

getPressDuration

getPressDuration(): bigint
Gets the number of ticks the button stays pressed for. Stone buttons stay pressed for 20 ticks, and wooden buttons for 30.

Returns bigint
- Defined in packages/core/src/block/traits/button.ts:63

getState

getState(): boolean
Get the current state of the button.

Returns boolean
The current state of the button (pressed or not).
- Defined in packages/core/src/block/traits/button.ts:75

`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: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.
Inherited from BlockTrait.onBreak
- Defined in packages/core/src/block/traits/trait.ts:101

`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:133

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/button.ts:22

`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:127

`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:94

`Optional`onRandomTick

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

Returns void
Inherited from BlockTrait.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 BlockTrait.onRemove
- Defined in packages/core/src/trait.ts:52

`Optional`onReplace

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

`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:107

`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:113

onTick

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

Returns void
Overrides BlockTrait.onTick
- Defined in packages/core/src/block/traits/button.ts:45

`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:87

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 BlockTrait.setRandomTickProbability
- Defined in packages/core/src/trait.ts:102

setState

setState(state: boolean, silent?: boolean): void
Set the state of the button.
Parameters
- state: boolean
  The desired state of the button (true for pressed, false for not pressed).
- silent: boolean = false
  If the sound event should be played (default is false).
Returns void
- Defined in packages/core/src/block/traits/button.ts:85

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 BlockTrait.shouldRandomTick
- Defined in packages/core/src/trait.ts:78

Class BlockButtonTrait

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BlockButtonTrait

Properties

Protected Readonlyblock

Readonlycomponent

Protected Readonlydimension

Readonlyidentifier

releaseTick

Readonlystate

Readonlytag

Static Readonlycomponent

Static Readonlyidentifier

Static Readonlystate

Static Readonlytag

Static Readonlytypes

Methods

ProtectedbreakNextTick

Parameters

Returns void

clone

Parameters

Returns Trait

getPressDuration

Returns bigint

getState

Returns boolean

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

OptionalonRandomTick

Returns void

OptionalonRemove

Returns void

OptionalonReplace

Returns void

OptionalonStartBreak

Parameters

Returns boolean | void

OptionalonStopBreak

Parameters

Returns void

onTick

Returns void

OptionalonUpdate

Parameters

Returns void

setRandomTickProbability

Parameters

Returns void

setState

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

`Protected`breakNextTick

`Optional`onAdd

`Optional`onBreak

`Optional`onContainerUpdate

`Optional`onPick

`Optional`onPlace

`Optional`onRandomTick

`Optional`onRemove

`Optional`onReplace

`Optional`onStartBreak

`Optional`onStopBreak

`Optional`onUpdate