Class Dimension

constructor

• new Dimension(world: World, properties?: DimensionProperties): Dimension

  Creates a new dimension for a world.

  Parameters

  • world: World

    The world that the dimension will belong to.
  • Optionalproperties: DimensionProperties

    The properties of the dimension.

  Returns Dimension

Readonlyblocks

Readonlyentities

Readonlygenerator

Readonlyidentifier

Readonlyproperties

Readonlytype

Readonlyworld

simulationDistance

• get simulationDistance(): number

  The distance in chunks that entities will be simulated.

  Returns number
• set simulationDistance(value: number): void

  The distance in chunks that entities will be simulated.

  Parameters

  • value: number

  Returns void

spawnPosition

• get spawnPosition(): Vector3f

  The spawn position of the dimension.

  Returns Vector3f
• set spawnPosition(value: IPosition): void

  The spawn position of the dimension.

  Parameters

  • value: IPosition

  Returns void

viewDistance

• get viewDistance(): number

  The amount of chunks that that will be rendered by the client.

  Returns number
• set viewDistance(value: number): void

  The amount of chunks that that will be rendered by the client.

  Parameters

  • value: number

  Returns void

broadcast

• broadcast(...packets: DataPacket[]): void

  Broadcast packets to all the players in the dimension.

  Parameters

  • ...packets: DataPacket[]

    The packets to broadcast.

  Returns void

broadcastExcept

• broadcastExcept(excludedPlayer: Player, ...packets: DataPacket[]): void

  Broadcast packets to all the players in the dimension except the specified player.

  Parameters

  • excludedPlayer: Player
  • ...packets: DataPacket[]

    The packets to broadcast.

  Returns void

broadcastImmediate

• broadcastImmediate(...packets: DataPacket[]): void

  Broadcast packets to all the players in the dimension immediately. This will bypass the RakNet queue and send the packets immediately.

  Parameters

  • ...packets: DataPacket[]

    The packets to broadcast.

  Returns void

executeCommand

• executeCommand<T = unknown>(command: string): CommandResponse<T>

  Executes a command in the dimension.

  Type Parameters

  • T = unknown

  Parameters

  • command: string

    The command to execute.

  Returns CommandResponse<T>

  The response of the command.

executeCommandAsync

• executeCommandAsync<T = unknown>(command: string): Promise<CommandResponse<T>>

  Executes a command in the dimension asynchronously.

  Type Parameters

  • T = unknown

  Parameters

  • command: string

    The command to execute.

  Returns Promise<CommandResponse<T>>

  The response of the command.

fill

• fill(from: IPosition, to: IPosition, permutation: BlockPermutation): number

  Fills a region with a permutation.

  Parameters

  • from: IPosition

    The starting position.
  • to: IPosition

    The ending position.
  • permutation: BlockPermutation

    The permutation to fill the region with.

  Returns number

  The amount of blocks that were filled.

getBiome

• getBiome(position: IPosition): BiomeType

  Get a biome from the dimension at a given position.

  Parameters

  • position: IPosition

    The position to get the biome from.

  Returns BiomeType

  The biome at the specified position.

getBlock

• getBlock(position: IPosition): Block

  Gets a block from the dimension.

  Parameters

  • position: IPosition

    The position of the block.

  Returns Block

  The block at the specified position.

getChunk

• getChunk(cx: number, cz: number): Chunk

  Gets a chunk from the dimension.

  Parameters

  • cx: number

    The chunk x coordinate.
  • cz: number

    The chunk z coordinate.

  Returns Chunk

  The chunk at the specified coordinates.

getEntities

• getEntities(options?: EntityQueryOptions): Entity[]

  Gets all the entities in the dimension.

  Parameters

  • Optionaloptions: EntityQueryOptions

    The options to filter the entities.

  Returns Entity[]

  An array of entities.

getEntity

• getEntity(id: bigint, runtimeId?: boolean): null | Entity

  Gets an entity from the dimension.

  Parameters

  • id: bigint

    The id of the entity, either unique id or runtime id.
  • runtimeId: boolean = false

    Whether to get the entity by runtime id; defaults to false.

  Returns null | Entity

  The entity if found, otherwise null.

getPermutation

• getPermutation(position: IPosition, layer?: number): BlockPermutation

  Get the permutation of a block at a given position. This method won't construct a block instance.

  Parameters

  • position: IPosition

    The position of the block.
  • layer: number = 0

  Returns BlockPermutation

  The block permutation at the specified position.

getPlayers

• getPlayers(options?: EntityQueryOptions): Player[]

  Gets all the players in the dimension.

  Parameters

  • Optionaloptions: EntityQueryOptions

  Returns Player[]

  An array of players.

getTopmostBlock

• getTopmostBlock(position: IPosition): Block

  Gets the topmost block in which the permutation is not air, at the given X and Z coordinates.

  Parameters

  • position: IPosition

    The position to query.

  Returns Block

  The topmost block in which the permutation is not air.

indexOf

• indexOf(): number

  Gets the dimension index in the world.

  Returns number

  The dimension index.

onTick

• onTick(deltaTick: number): void

  Ticks the dimension with a given delta tick.

  Parameters

  • deltaTick: number

    The delta tick to tick the dimension with.

  Returns void

placeStructure

• placeStructure(
      identifier: string | Structure,
      position: IPosition,
      options?: StructurePlaceOptions,
  ): Promise<void>

  Place a structure in the dimension at a specified position asynchronously.

  Parameters

  • identifier: string | Structure

    The identifier of the structure or the structure instance itself.
  • position: IPosition

    The position to place the structure at.
  • Optionaloptions: StructurePlaceOptions

    The options to place the structure with.

  Returns Promise<void>

  Throws

  Will throw an error if the structure is not found.

schedule

• schedule(ticks: number, callback?: () => void): TickSchedule

  Schedule an execution of a function after a specified amount of ticks.

  Parameters

  • ticks: number

    The amount of ticks to wait before the schedule is complete.
  • Optionalcallback: () => void

  Returns TickSchedule

  The created tick schedule.

scheduleAsync

• scheduleAsync(ticks: number): Promise<void>

  Schedules an execution of a function after a specified amount of ticks asynchronously.

  Parameters

  • ticks: number

    The amount of ticks to wait before the schedule is complete.

  Returns Promise<void>

  A promise that resolves when the schedule is complete.

sendMessage

• sendMessage(message: string | RawMessage): void

  Broadcasts a message to all players in the dimension.

  Parameters

  • message: string | RawMessage

    The message to broadcast.

  Returns void

setBiome

• setBiome(position: IPosition, biome: BiomeType): void

  Set a biome in the dimension at a given position.

  Parameters

  • position: IPosition

    The position to set the biome at.
  • biome: BiomeType

    The biome to set.

  Returns void

setChunk

• setChunk(chunk: Chunk): void

  Sets a chunk in the dimension.

  Parameters

  • chunk: Chunk

    The chunk to set.

  Returns void

setPermutation

• setPermutation(
      position: IPosition,
      permutation: BlockPermutation,
      layer?: UpdateBlockLayerType,
  ): void

  Sets the permutation of a block at a given position.

  Parameters

  • position: IPosition

    The position of the block.
  • permutation: BlockPermutation

    The permutation to set.
  • layer: UpdateBlockLayerType = UpdateBlockLayerType.Normal

    The layer to set the permutation on.

  Returns void

spawnEntity

• spawnEntity(
      type: EntityIdentifier | EntityType,
      position: Vector3f,
      spawnImmediately?: boolean,
  ): Entity

  Spawns an entity in the dimension.

  Parameters

  • type: EntityIdentifier | EntityType

    The type of the entity.
  • position: Vector3f

    The position of the entity.
  • spawnImmediately: boolean = true

    Whether to spawn the entity immediately; defaults to true.

  Returns Entity

  The entity that was spawned.

spawnExperienceOrb

• spawnExperienceOrb(experience: number, position: IPosition): Entity

  Spawns an experience orb in the dimension.

  Parameters

  • experience: number

    The amount of experience the orb will give.
  • position: IPosition

    The position to spawn the orb at.

  Returns Entity

  The entity instance that was spawned.

spawnItem

• spawnItem(itemStack: ItemStack, position: IPosition): Entity

  Spawns an item in the dimension.

  Parameters

  • itemStack: ItemStack

    The item stack of the item.
  • position: IPosition

    The position of the item.

  Returns Entity

  The entity that was spawned.