Class WorldProvider

constructor

• new WorldProvider(..._parameters: unknown[]): WorldProvider

  Create a new world provider.

  Parameters

  • ..._parameters: unknown[]

  Returns WorldProvider

Readonlybarrowers

Readonlychunks

Readonlyidentifier

world

Static Readonlyidentifier

onSave

• onSave(): void

  Called when the provider is saved.

  Returns void

onShutdown

• onShutdown(): void

  Called when the provider is shutdown.

  Returns void

onStartup

• onStartup(): void

  Called when the provider is started.

  Returns void

readBuffer

• readBuffer(_key: string): Buffer

  Reads a buffer from the provider.

  Parameters

  • _key: string

  Returns Buffer

  The buffer data entry.

readChunk

• readChunk(_chunk: Chunk, _dimension: Dimension): Promise<Chunk>

  Read a chunk for a specified dimension from the provider.

  Parameters

  • _chunk: Chunk
  • _dimension: Dimension

  Returns Promise<Chunk>

readChunkBlocks

• readChunkBlocks(_chunk: Chunk, _dimension: Dimension): BlockLevelStorage[]

  Parameters

  • _chunk: Chunk
  • _dimension: Dimension

  Returns BlockLevelStorage[]

readChunkEntities

• readChunkEntities(_chunk: Chunk, _dimension: Dimension): CompoundTag[]

  Parameters

  • _chunk: Chunk
  • _dimension: Dimension

  Returns CompoundTag[]

readPlayer

• readPlayer(_uuid: string): null | CompoundTag

  Reads a players data from the provider.

  Parameters

  • _uuid: string

  Returns null | CompoundTag

  The player data if found, otherwise null.

rentChunk

• rentChunk(hash: bigint, dimension: Dimension): void

  Rents a chunk from the provider, this will increment the barrower count for the chunk.

  Parameters

  • hash: bigint

    The hash of the chunk to rent.
  • dimension: Dimension

    The dimension to rent the chunk from.

  Returns void

returnChunk

• returnChunk(hash: bigint, dimension: Dimension): void

  Returns a chunk to the provider, this will decrement the barrower count for the chunk.

  Parameters

  • hash: bigint

    The hash of the chunk to return.
  • dimension: Dimension

    The dimension to return the chunk to.

  Returns void

writeBuffer

• writeBuffer(_key: string, _value: Buffer): void

  Writes a buffer to the provider.

  Parameters

  • _key: string
  • _value: Buffer

  Returns void

writeChunk

• writeChunk(_chunk: Chunk, _dimension: Dimension): Promise<void>

  Writes a chunk for a specified dimension to the provider.

  Parameters

  • _chunk: Chunk
  • _dimension: Dimension

  Returns Promise<void>

writeChunkBlocks

• writeChunkBlocks(
      _chunk: Chunk,
      _dimension: Dimension,
      _blocks: BlockLevelStorage[],
  ): void

  Parameters

  • _chunk: Chunk
  • _dimension: Dimension
  • _blocks: BlockLevelStorage[]

  Returns void

writeChunkEntities

• writeChunkEntities(
      _chunk: Chunk,
      _dimension: Dimension,
      _entities: [bigint, CompoundTag][],
  ): void

  Parameters

  • _chunk: Chunk
  • _dimension: Dimension
  • _entities: [bigint, CompoundTag][]

  Returns void

writePlayer

• writePlayer(_uuid: string, _player: CompoundTag): void

  Writes a players data to the provider.

  Parameters

  • _uuid: string
  • _player: CompoundTag

  Returns void

Staticcreate

• create(
      _serenity: Serenity,
      _properties: WorldProviderProperties,
      _worldProperties?: Partial<WorldProperties>,
  ): Promise<World>

  Parameters

  • _serenity: Serenity
  • _properties: WorldProviderProperties
  • Optional_worldProperties: Partial<WorldProperties>

  Returns Promise<World>

StaticcreateFromGivenPath

• createFromGivenPath(
      _serenity: Serenity,
      _path: string,
      _worldProperties?: Partial<WorldProperties>,
  ): Promise<World>

  Creates a world from a given path.

  Parameters

  • _serenity: Serenity
  • _path: string
  • Optional_worldProperties: Partial<WorldProperties>

  Returns Promise<World>

Staticinitialize

• initialize(
      _serenity: Serenity,
      _properties: WorldProviderProperties,
  ): Promise<void>

  Initializes the provider with the specified properties.

  Parameters

  • _serenity: Serenity
  • _properties: WorldProviderProperties

  Returns Promise<void>

StaticloadFromExistingPath

• loadFromExistingPath(_serenity: Serenity, _path: string): Promise<World>

  Loads a world from an existing path.

  Parameters

  • _serenity: Serenity
  • _path: string

  Returns Promise<World>