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,
    properties?: Partial<BlockProperties>,
): Block
Parameters
- dimension: Dimension
- position: BlockPosition
- Optionalproperties: Partial<BlockProperties>
Returns Block
- Defined in packages/core/src/block/block.ts:276

Properties

`Readonly`dimension

dimension: Dimension

The dimension the block is in.

`Readonly`dyanamicProperties

dyanamicProperties: Map<string, JSONLikeValue> = ...

The dynamic properties that are attached to the block. Dynamic properties is additional data that is attached to the block and will be saved with the world database. These are usaully used by traits to store additional data, but can be used by other systems as well.

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

nbt: NbtMap = ...

The nbt data that is attached to the block. Nbt data is additional data that is attached to the block and will be saved with the world database. The format of the nbt data is exactly the same as the nbt format of vanilla Minecraft. This data is used to apply additional metadata to the block. (Custom Name, Chest Open/Closed, etc.)

`Readonly`position

position: BlockPosition

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

`Protected` `Readonly`serenity

serenity: Serenity

The serenity instance of the server.

`Readonly`traits

traits: Map<string, BlockTrait> = ...

The traits that are attached to the block. Traits add additional behavior to the block and only the trait identifier will be saved with the world database. Traits generally use components or nbt to store additional data.

Accessors

direction

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

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

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:117
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:124

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

isLavaLogged

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

Returns boolean
- Defined in packages/core/src/block/block.ts:214
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:228

isLiquid

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

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

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

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

isWaterlogged

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

Returns boolean
- Defined in packages/core/src/block/block.ts:184
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:198

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:137
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:146

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:102
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:110

world

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

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

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

addDynamicProperty

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

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

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

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

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

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

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

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

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

getDataEntry

getDataEntry(): BlockEntry
Gets the block's data as a database entry.

Returns BlockEntry
The block entry object.
- Defined in packages/core/src/block/block.ts:1131

getDynamicProperty

getDynamicProperty<T extends JSONLikeObject>(key: string): null | T
Gets the specified dynamic property from the block.
Type Parameters
- T extends JSONLikeObject
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:441

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

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

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

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

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

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

getPermutation

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

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

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

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

getToolType

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

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

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:490
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:497

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

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

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

loadDataEntry

loadDataEntry(world: World, entry: BlockEntry, overwrite?: boolean): void
Loads the block data from a block entry object.
Parameters
- world: World
  The world the block is in.
- entry: BlockEntry
  The block entry object to load the block data from.
- overwrite: boolean = true
  Whether to overwrite the block data.
Returns void
- Defined in packages/core/src/block/block.ts:1162

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

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

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

setDynamicProperty

setDynamicProperty<T extends JSONLikeObject>(key: string, property: T): void
Sets the specified dynamic property to the block.
Type Parameters
- T extends JSONLikeObject
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:467

setPermutation

setPermutation(permutation: BlockPermutation, entry?: BlockEntry): void
Sets the permutation of the block.
Parameters
- permutation: BlockPermutation
  The permutation to set the block to.
- Optionalentry: BlockEntry
  The block entry to load the block data from.
Returns void
- Defined in packages/core/src/block/block.ts:385

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

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

spawnLoot

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

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

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

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

Class Block

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Block

Properties

Readonlydimension

ReadonlydyanamicProperties

isTicking

Readonlynbt

Readonlyposition

Protected Readonlyserenity

Readonlytraits

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

addTrait

Type Parameters

Parameters

Returns InstanceType<T>

below

Parameters

Returns Block

destroy

Parameters

Returns boolean

east

Parameters

Returns Block

face

Parameters

Returns Block

getBreakTime

Parameters

Returns number

getChunk

`Readonly`dimension

`Readonly`dyanamicProperties

`Readonly`nbt

`Readonly`position

`Protected` `Readonly`serenity

`Readonly`traits