Class LevelDBProvider

Hierarchy (View Summary)

WorldProvider
- LevelDBProvider

Constructors

constructor

new LevelDBProvider(path: string): LevelDBProvider
Parameters
- path: string
Returns LevelDBProvider
Overrides WorldProvider.constructor
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:49

Properties

`Readonly`chunks

chunks: WeakMap<Dimension, Map<bigint, Chunk>> = ...

The cached chunks for the provider.

`Readonly`db

db: Leveldb

The database instance for the provider.

`Readonly`identifier

identifier: string = ...

The identifier of the provider.

`Readonly`path

path: string

The path of the provider.

world

world: World

The world that the provider belongs to.

`Static` `Readonly`identifier

identifier: string = "leveldb"

The identifier of the provider.

Methods

hasChunk

hasChunk(cx: number, cz: number, dimension: Dimension): boolean
Checks if the database has a chunk.
Parameters
- cx: number
  The chunk X coordinate.
- cz: number
  The chunk Z coordinate.
- dimension: Dimension
  The dimension to check for the chunk.
Returns boolean
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:435

onSave

onSave(): Promise<void>
Called when the provider is saved.

Returns Promise<void>
Overrides WorldProvider.onSave
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:164

onShutdown

onShutdown(): Promise<void>
Called when the provider is shutdown.

Returns Promise<void>
Overrides WorldProvider.onShutdown
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:78

onStartup

onStartup(): Promise<void>
Called when the provider is started.

Returns Promise<void>
Overrides WorldProvider.onStartup
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:112

readBuffer

readBuffer(key: string): null | Buffer<ArrayBufferLike>
Reads a buffer from the provider.
Parameters
- key: string
  The key to read the buffer from.
Returns null | Buffer<ArrayBufferLike>
The buffer data entry.
Overrides WorldProvider.readBuffer
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:183

readChunk

readChunk(chunk: Chunk, dimension: Dimension): Promise<Chunk>
Read a chunk for a specified dimension from the provider.
Parameters
- chunk: Chunk
  The chunk where the data will be written to.
- dimension: Dimension
  The dimension to read the chunk from.
Returns Promise<Chunk>
Overrides WorldProvider.readChunk
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:195

readChunkBiomes

readChunkBiomes(chunk: Chunk, dimension: Dimension): BiomeStorage[]
Parameters
- chunk: Chunk
- dimension: Dimension
Returns BiomeStorage[]
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:706

readChunkBlocks

readChunkBlocks(chunk: Chunk, dimension: Dimension): BlockLevelStorage[]
Parameters
- chunk: Chunk
- dimension: Dimension
Returns BlockLevelStorage[]
Overrides WorldProvider.readChunkBlocks
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:605

readChunkEntities

readChunkEntities(chunk: Chunk, dimension: Dimension): CompoundTag[]
Parameters
- chunk: Chunk
- dimension: Dimension
Returns CompoundTag[]
Overrides WorldProvider.readChunkEntities
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:518

readPlayer

readPlayer(uuid: string): null | CompoundTag
Reads a players data from the provider.
Parameters
- uuid: string
  The uuid of the player to read.
Returns null | CompoundTag
The player data if found, otherwise null.
Overrides WorldProvider.readPlayer
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:670

readSubChunk

readSubChunk(cx: number, cy: number, cz: number, dimension: Dimension): SubChunk
Reads a subchunk from the database.
Parameters
- cx: number
  The chunk X coordinate.
- cy: number
  The subchunk Y coordinate.
- cz: number
  The chunk Z coordinate.
- dimension: Dimension
  The dimension to read the subchunk from.
Returns SubChunk
The subchunk from the database.
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:463

writeBuffer

writeBuffer(key: string, value: Buffer): void
Writes a buffer to the provider.
Parameters
- key: string
  The key to write the buffer to.
- value: Buffer
  The buffer data to write.
Returns void
Overrides WorldProvider.writeBuffer
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:191

writeChunk

writeChunk(chunk: Chunk, dimension: Dimension): Promise<void>
Writes a chunk for a specified dimension to the provider.
Parameters
- chunk: Chunk
  The chunk to write.
- dimension: Dimension
  The dimension to write the chunk to.
Returns Promise<void>
Overrides WorldProvider.writeChunk
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:357

writeChunkBiomes

writeChunkBiomes(chunk: Chunk, dimension: Dimension): void
Parameters
- chunk: Chunk
- dimension: Dimension
Returns void
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:744

writeChunkBlocks

writeChunkBlocks(
    chunk: Chunk,
    dimension: Dimension,
    blocks: BlockLevelStorage[],
): void
Parameters
- chunk: Chunk
- dimension: Dimension
- blocks: BlockLevelStorage[]
Returns void
Overrides WorldProvider.writeChunkBlocks
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:646

writeChunkEntities

writeChunkEntities(
    chunk: Chunk,
    dimension: Dimension,
    entities: [bigint, CompoundTag][],
): void
Parameters
- chunk: Chunk
- dimension: Dimension
- entities: [bigint, CompoundTag][]
Returns void
Overrides WorldProvider.writeChunkEntities
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:568

writeChunkVersion

writeChunkVersion(
    cx: number,
    cz: number,
    dimension: Dimension,
    version: number,
): void
Write the chunk version to the database.
Parameters
- cx: number
  The chunk X coordinate.
- cz: number
  The chunk Z coordinate.
- dimension: Dimension
- version: number
  The chunk version.
Returns void
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:412

writePlayer

writePlayer(uuid: string, player: CompoundTag): void
Writes a players data to the provider.
Parameters
- uuid: string
  The uuid of the player to write.
- player: CompoundTag
  The player data to write.
Returns void
Overrides WorldProvider.writePlayer
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:692

writeSubChunk

writeSubChunk(
    subchunk: SubChunk,
    cx: number,
    cy: number,
    cz: number,
    dimension: Dimension,
): void
Writes a subchunk to the database.
Parameters
- subchunk: SubChunk
  The subchunk to write.
- cx: number
  The chunk X coordinate.
- cy: number
  The subchunk Y coordinate.
- cz: number
  The chunk Z coordinate.
- dimension: Dimension
  The dimension to write the subchunk to.
Returns void
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:495

`Static`create

create(
    serenity: Serenity,
    properties: WorldProviderProperties,
    worldProperties?: Partial<WorldProperties>,
): Promise<World>
Parameters
- serenity: Serenity
- properties: WorldProviderProperties
- OptionalworldProperties: Partial<WorldProperties>
Returns Promise<World>
Overrides WorldProvider.create
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:869

`Static`createFromGivenPath

createFromGivenPath(
    serenity: Serenity,
    path: string,
    worldProperties?: Partial<WorldProperties>,
): Promise<World>
Creates a world from a given path.
Parameters
- serenity: Serenity
  The serenity instance to use.
- path: string
  The path to load the world from.
- OptionalworldProperties: Partial<WorldProperties>
  The world properties to use for the world.
Returns Promise<World>
Overrides WorldProvider.createFromGivenPath
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:955

`Static`initialize

initialize(
serenity: Serenity,
properties: WorldProviderProperties,
): Promise<void>
Initializes the provider with the specified properties.
Parameters
- serenity: Serenity
  The serenity instance to use.
- properties: WorldProviderProperties
  The properties to use for the provider.
Returns Promise<void>
Overrides WorldProvider.initialize
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:767

`Static`loadFromExistingPath

loadFromExistingPath(serenity: Serenity, path: string): Promise<World>
Loads a world from an existing path.
Parameters
- serenity: Serenity
  The serenity instance to use.
- path: string
  The path to load the world from.
Returns Promise<World>
Overrides WorldProvider.loadFromExistingPath
- Defined in packages/core/src/world/provider/leveldb/leveldb.ts:916

Class LevelDBProvider

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LevelDBProvider

Properties

Readonlychunks

Readonlydb

Readonlyidentifier

Readonlypath

world

Static Readonlyidentifier

Methods

hasChunk

Parameters

Returns boolean

onSave

Returns Promise<void>

onShutdown

Returns Promise<void>

onStartup

Returns Promise<void>

readBuffer

Parameters

Returns null | Buffer<ArrayBufferLike>

readChunk

Parameters

Returns Promise<Chunk>

readChunkBiomes

Parameters

Returns BiomeStorage[]

readChunkBlocks

Parameters

Returns BlockLevelStorage[]

readChunkEntities

Parameters

Returns CompoundTag[]

readPlayer

Parameters

Returns null | CompoundTag

readSubChunk

Parameters

Returns SubChunk

writeBuffer

Parameters

Returns void

writeChunk

Parameters

Returns Promise<void>

writeChunkBiomes

Parameters

Returns void

writeChunkBlocks

Parameters

Returns void

writeChunkEntities

Parameters

Returns void

writeChunkVersion

Parameters

Returns void

writePlayer

Parameters

Returns void

writeSubChunk

Parameters

Returns void

Staticcreate

Parameters

Returns Promise<World>

StaticcreateFromGivenPath

Parameters

Returns Promise<World>

Staticinitialize

Parameters

`Readonly`chunks

`Readonly`db

`Readonly`identifier

`Readonly`path

`Static` `Readonly`identifier

`Static`create

`Static`createFromGivenPath

`Static`initialize

`Static`loadFromExistingPath