Class Block

Block is a class the represents an instance of a block in a dimension of a world. The Block instance contains its position, dimension, type, permutation, components, traits, and nbt data. Blocks can be interacted with, destroyed, and have additional behavior added to them through traits.

 // Fetching a block from a dimension.
 const query = dimension.getBlock({ x: 0, y: 0, z: 0 });

Constructors

constructor

new Block(
    dimension: Dimension,
    position: BlockPosition,
    storage?: BlockLevelStorage,
): Block
Parameters
- dimension: Dimension
- position: BlockPosition
- Optionalstorage: BlockLevelStorage
Returns Block
- Defined in packages/core/src/block/block.ts:259

Properties

`Readonly`dimension

dimension: Dimension

The dimension the block is in.

isTicking

isTicking: boolean = false

Whether the block is currently ticking or not. If true, this means the behaviors of the block are being processed. If false, this means the block currently isn't within the simulation distance from a player.

`Readonly`position

position: BlockPosition

The position of the block. (x, y, z)

`Protected` `Readonly`serenity

serenity: Serenity

The serenity instance of the server.

Accessors

direction

get direction(): CardinalDirection
The direction the block is facing.

Returns CardinalDirection
- Defined in packages/core/src/block/block.ts:234
set direction(direction: CardinalDirection): void
The direction the block is facing.
Parameters
- direction: CardinalDirection
Returns void
- Defined in packages/core/src/block/block.ts:248

identifier

get identifier(): BlockIdentifier
The block identifier of the block. (minecraft:stone, minecraft:oak_log, minecraft:air, etc.)

Returns BlockIdentifier
- Defined in packages/core/src/block/block.ts:100
set identifier(identifier: BlockIdentifier): void
The block identifier of the block. (minecraft:stone, minecraft:oak_log, minecraft:air, etc.)
Parameters
- identifier: BlockIdentifier
Returns void
- Defined in packages/core/src/block/block.ts:107

isAir

get isAir(): boolean
Whether or not the block is air. Usaully if the block is air, it is not cached in the dimension.

Returns boolean
- Defined in packages/core/src/block/block.ts:137

isLavaLogged

get isLavaLogged(): boolean
Whether or not the block is lava logged.

Returns boolean
- Defined in packages/core/src/block/block.ts:197
set isLavaLogged(value: boolean): void
Whether or not the block is lava logged.
Parameters
- value: boolean
Returns void
- Defined in packages/core/src/block/block.ts:211

isLiquid

get isLiquid(): boolean
Whether or not the block is liquid.

Returns boolean
- Defined in packages/core/src/block/block.ts:144

isLoggable

get isLoggable(): boolean
Whether or not the block is loggable. Depening on the value, this will determine if the block can be logged with a fluid type block.

Returns boolean
- Defined in packages/core/src/block/block.ts:160

isSolid

get isSolid(): boolean
Whether or not the block is solid. Depening on the value, this will determine if entities can pass through the block.

Returns boolean
- Defined in packages/core/src/block/block.ts:152

isWaterlogged

get isWaterlogged(): boolean
Whether or not the block is waterlogged.

Returns boolean
- Defined in packages/core/src/block/block.ts:167
set isWaterlogged(value: boolean): void
Whether or not the block is waterlogged.
Parameters
- value: boolean
Returns void
- Defined in packages/core/src/block/block.ts:181

permutation

get permutation(): BlockPermutation
The current permutation of the block. The permutation contains the specific state of the block, which determines the block's appearance and behavior. The permutation is a combination of the block type and the block state.

Returns BlockPermutation
- Defined in packages/core/src/block/block.ts:120
set permutation(permutation: BlockPermutation): void
The current permutation of the block. The permutation contains the specific state of the block, which determines the block's appearance and behavior. The permutation is a combination of the block type and the block state.
Parameters
- permutation: BlockPermutation
Returns void
- Defined in packages/core/src/block/block.ts:129

type

get type(): BlockType
The block type of the block. This property will contain any additional metadata that is global to the block type.

Returns BlockType
- Defined in packages/core/src/block/block.ts:85
set type(type: BlockType): void
The block type of the block. This property will contain any additional metadata that is global to the block type.
Parameters
- type: BlockType
Returns void
- Defined in packages/core/src/block/block.ts:93

world

get world(): World
Gets the current world the block is in.

Returns World
- Defined in packages/core/src/block/block.ts:310

Methods

above

above(steps?: number): Block
Gets the block above this block.
Parameters
- Optionalsteps: number
  The amount of steps to go up.
Returns Block
- Defined in packages/core/src/block/block.ts:847

addDynamicProperty

addDynamicProperty(key: string, property: JSONLikeValue): void
Adds a dynamic property to the block.
Parameters
- key: string
  The key of the dynamic property to add.
- property: JSONLikeValue
  The dynamic property to add.
Returns void
- Defined in packages/core/src/block/block.ts:515

addStorageEntry

addStorageEntry<T extends BaseTag>(tag: T): T
Adds a tag entry to the level storage.
Type Parameters
- T extends BaseTag
Parameters
- tag: T
  The tag entry to add.
Returns T
The tag entry that was added.
- Defined in packages/core/src/block/block.ts:738

addTrait

addTrait<T extends typeof BlockTrait>(
trait: T,
options?: ConstructorParameters<T>[1],
): InstanceType<T>
Adds a trait to the block.
Type Parameters
- T extends typeof BlockTrait
Parameters
- trait: T
  The trait to add to the block.
- Optionaloptions: ConstructorParameters<T>[1]
  The additional options to pass to the trait.
Returns InstanceType<T>
The trait instance that was added to the block.
- Defined in packages/core/src/block/block.ts:607

below

below(steps?: number): Block
Gets the block below this block.
Parameters
- Optionalsteps: number
  The amount of steps to go down.
Returns Block
- Defined in packages/core/src/block/block.ts:859

deleteStorageEntry

deleteStorageEntry(name: string): boolean
Deletes a tag entry from the level storage.
Parameters
- name: string
  The name of the tag entry to delete.
Returns boolean
Whether the tag entry was deleted or not.
- Defined in packages/core/src/block/block.ts:771

destroy

destroy(options?: Partial<BlockDestroyOptions>): boolean
Destroys the block, dropping its loot if specified.
Parameters
- Optionaloptions: Partial<BlockDestroyOptions>
  The options for destroying the block.
Returns boolean
Whether the block was destroyed successfully; otherwise, false.
- Defined in packages/core/src/block/block.ts:992

east

east(steps?: number): Block
Gets the block to the east of this block.
Parameters
- Optionalsteps: number
  The amount of steps to go east.
Returns Block
- Defined in packages/core/src/block/block.ts:895

face

face(face: BlockFace): Block
Gets the corresponding block next to a given block face of the block.
Parameters
- face: BlockFace
  The face of the block.
Returns Block
- Defined in packages/core/src/block/block.ts:919

getAllDynamicProperties

getAllDynamicProperties(): [string, JSONLikeValue][]
Get all dynamic properties of the block.

Returns [string, JSONLikeValue][]
A map of all dynamic properties of the block.
- Defined in packages/core/src/block/block.ts:535

getAllTraits

getAllTraits(): BlockTrait[]
Get all traits currently applied to the block.

Returns BlockTrait[]
An array of all traits currently applied to the block.
- Defined in packages/core/src/block/block.ts:668

getBreakTime

getBreakTime(itemStack?: null | ItemStack): number
Get the time it takes to break the block.
Parameters
- OptionalitemStack: null | ItemStack
  The item stack used to break the block.
Returns number
The time it takes to break the block.
- Defined in packages/core/src/block/block.ts:1102

getChunk

getChunk(): Chunk
Gets the chunk the block is in.

Returns Chunk
The chunk the block is in.
- Defined in packages/core/src/block/block.ts:348

getCollisionBox

getCollisionBox(): null | BlockTypeCollisionBoxComponent
Get the collision box of the block.

Returns null | BlockTypeCollisionBoxComponent
The collision box of the block.
- Defined in packages/core/src/block/block.ts:1286

getDynamicProperty

getDynamicProperty<T extends JSONLikeValue>(key: string): null | T
Gets the specified dynamic property from the block.
Type Parameters
- T extends JSONLikeValue
Parameters
- key: string
  The key of the dynamic property to get from the block.
Returns null | T
The dynamic property if it exists, otherwise null.
- Defined in packages/core/src/block/block.ts:498

getFriction

getFriction(): number
Get the amount of friction of the block.

Returns number
The amount of friction of the block.
- Defined in packages/core/src/block/block.ts:1269

getGeometry

getGeometry(): null | BlockTypeGeometryComponent
Get the geometry of the block.

Returns null | BlockTypeGeometryComponent
The geometry of the block.
- Defined in packages/core/src/block/block.ts:1320

getHardness

getHardness(): number
Get the hardness of the block.

Returns number
The hardness level of the block.
- Defined in packages/core/src/block/block.ts:1235

getItemStack

getItemStack(options?: Partial<ItemStackOptions>): ItemStack
Gets the item stack of the block.
Parameters
- Optionaloptions: Partial<ItemStackOptions>
  The options for the item stack.
Returns ItemStack
The item stack of the block.
- Defined in packages/core/src/block/block.ts:813

getLightEmission

getLightEmission(): number
Get the amount of light emitted by the block.

Returns number
The amount of light emitted by the block.
- Defined in packages/core/src/block/block.ts:1252

getNeighborBlocks

getNeighborBlocks(): Block[]
Gets all the neighbor blocks around the block.

Returns Block[]
The neighbor blocks around the block.
- Defined in packages/core/src/block/block.ts:831

getPermutation

getPermutation(): BlockPermutation
Gets the current permutation of the block.

Returns BlockPermutation
- Defined in packages/core/src/block/block.ts:399

getSelectionBox

getSelectionBox(): null | BlockTypeSelectionBoxComponent
Get the selection box of the block.

Returns null | BlockTypeSelectionBoxComponent
The selection box of the block.
- Defined in packages/core/src/block/block.ts:1303

getState

getState<T>(key: string): T
Get the a specific state of the block.
Type Parameters
- T
Parameters
- key: string
  The key of the state to get.
Returns T
The value of the state.
- Defined in packages/core/src/block/block.ts:372

getStorage

getStorage(): BlockLevelStorage
Get the nbt level storage for the block.

Returns BlockLevelStorage
The current level storage of the block.
- Defined in packages/core/src/block/block.ts:676

getStorageEntry

getStorageEntry<T extends BaseTag>(name: string): null | T
Get a specific tag entry from the level storage.
Type Parameters
- T extends BaseTag
Parameters
- name: string
  The name of the tag entry to get.
Returns null | T
The tag entry if it exists, otherwise null.
- Defined in packages/core/src/block/block.ts:716

getToolType

getToolType(): BlockToolType
Gets the tool type required to break the block.

Returns BlockToolType
- Defined in packages/core/src/block/block.ts:802

getTrait

getTrait<T extends typeof BlockTrait>(trait: T): InstanceType<T>
Gets the specified trait from the block.
Type Parameters
- T extends typeof BlockTrait
Parameters
- trait: T
  The trait to get from the block
Returns InstanceType<T>
The trait if it exists, otherwise null
- Defined in packages/core/src/block/block.ts:557
getTrait(trait: string): null | BlockTrait
Gets the specified trait from the block.
Parameters
- trait: string
  The trait to get from the block
Returns null | BlockTrait
The trait if it exists, otherwise null
- Defined in packages/core/src/block/block.ts:564

hasDynamicProperty

hasDynamicProperty(key: string): boolean
Whether the block has the specified dynamic property.
Parameters
- key: string
  The key of the dynamic property to check for.
Returns boolean
Whether the block has the dynamic property.
- Defined in packages/core/src/block/block.ts:489

hasState

hasState(key: string): boolean
Check if the block has a specific state.
Parameters
- key: string
  The key of the state to check for.
Returns boolean
Whether the block has the state or not.
- Defined in packages/core/src/block/block.ts:362

hasStorageEntry

hasStorageEntry(name: string): boolean
Check if the level storage has a specific tag entry.
Parameters
- name: string
  The name of the tag entry to check for.
Returns boolean
Whether the tag entry exists or not.
- Defined in packages/core/src/block/block.ts:707

hasTrait

hasTrait(trait: string | typeof BlockTrait): boolean
Whether the block has the specified trait.
Parameters
- trait: string | typeof BlockTrait
  The trait to check for
Returns boolean
Whether the block has the trait
- Defined in packages/core/src/block/block.ts:544

interact

interact(options?: Partial<BlockInteractionOptions>): BlockInteractionOptions
Interact with the block, calling the onInteract method of the block traits.
Parameters
- Optionaloptions: Partial<BlockInteractionOptions>
Returns BlockInteractionOptions
- Defined in packages/core/src/block/block.ts:945

north

north(steps?: number): Block
Gets the block to the north of this block.
Parameters
- Optionalsteps: number
  The amount of steps to go north.
Returns Block
- Defined in packages/core/src/block/block.ts:871

pushStorageEntry

pushStorageEntry(...tags: BaseTag[]): void
Pushes multiple tag entries to the level storage.
Parameters
- ...tags: BaseTag[]
  The tag entries to push.
Returns void
- Defined in packages/core/src/block/block.ts:753

removeDynamicProperty

removeDynamicProperty(key: string): void
Removes the specified dynamic from the block.
Parameters
- key: string
  The key of the dynamic to remove.
Returns void
- Defined in packages/core/src/block/block.ts:506

removeTrait

removeTrait(trait: string | typeof BlockTrait): void
Removes the specified trait from the block.
Parameters
- trait: string | typeof BlockTrait
  The trait to remove
Returns void
- Defined in packages/core/src/block/block.ts:581

sendStorageUpdate

sendStorageUpdate(dirty?: boolean): void
Sends the current level storage to all players in the dimension.
Parameters
- dirty: boolean = true
Returns void
- Defined in packages/core/src/block/block.ts:782

setDynamicProperty

setDynamicProperty<T extends JSONLikeValue>(key: string, property: T): void
Sets the specified dynamic property to the block.
Type Parameters
- T extends JSONLikeValue
Parameters
- key: string
  The key of the dynamic property to set.
- property: T
  The dynamic property to set.
Returns void
- Defined in packages/core/src/block/block.ts:524

setPermutation

setPermutation(permutation: BlockPermutation, storage?: BlockLevelStorage): void
Sets the permutation of the block.
Parameters
- permutation: BlockPermutation
  The permutation to set the block to.
- Optionalstorage: BlockLevelStorage
  The level storage to load into the block.
Returns void
- Defined in packages/core/src/block/block.ts:408

setState

setState<T>(key: string, value: T): void
Sets the state of the block.
Type Parameters
- T
Parameters
- key: string
  The key of the state to set.
- value: T
  The value of the state to set.
Returns void
- Defined in packages/core/src/block/block.ts:381

setStorageEntry

setStorageEntry<T extends BaseTag>(name: string, tag: T): void
Set a specific tag entry in the level storage.
Type Parameters
- T extends BaseTag
Parameters
- name: string
  The name of the tag entry to set.
- tag: T
  The tag entry to set.
Returns void
- Defined in packages/core/src/block/block.ts:725

south

south(steps?: number): Block
Gets the block to the south of this block.
Parameters
- Optionalsteps: number
  The amount of steps to go south.
Returns Block
- Defined in packages/core/src/block/block.ts:883

spawnLoot

spawnLoot(): void
Spawns the loot that is associated with the block.

Returns void
- Defined in packages/core/src/block/block.ts:1058

update

update(surrounding?: boolean, source?: Block): void
Updates the block and surrounding blocks.
Parameters
- surrounding: boolean = false
  Whether to update the surrounding blocks.
- source: Block = ...
  The source of the update.
Returns void
- Defined in packages/core/src/block/block.ts:319

west

west(steps?: number): Block
Gets the block to the west of this block.
Parameters
- Optionalsteps: number
  The amount of steps to go west.
Returns Block
- Defined in packages/core/src/block/block.ts:907

Class Block

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Block

Properties

Readonlydimension

isTicking

Readonlyposition

Protected Readonlyserenity

Accessors

direction

Returns CardinalDirection

Parameters

Returns void

identifier

Returns BlockIdentifier

Parameters

Returns void

isAir

Returns boolean

isLavaLogged

Returns boolean

Parameters

Returns void

isLiquid

Returns boolean

isLoggable

Returns boolean

isSolid

Returns boolean

isWaterlogged

Returns boolean

Parameters

Returns void

permutation

Returns BlockPermutation

Parameters

Returns void

type

Returns BlockType

Parameters

Returns void

world

Returns World

Methods

above

Parameters

Returns Block

addDynamicProperty

Parameters

Returns void

addStorageEntry

Type Parameters

Parameters

Returns T

addTrait

Type Parameters

Parameters

Returns InstanceType<T>

below

Parameters

Returns Block

deleteStorageEntry

Parameters

Returns boolean

destroy

Parameters

Returns boolean

east

Parameters

Returns Block

face

Parameters

Returns Block

`Readonly`dimension

`Readonly`position

`Protected` `Readonly`serenity