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.ts:49

Properties

`Readonly`barrowers

barrowers: WeakMap<Dimension, Map<bigint, number>> = ...

The barrowers map for the provider.

`Readonly`chunks

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

The loaded chunks in 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.ts:388

onSave

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

Returns void
Overrides WorldProvider.onSave
- Defined in packages/core/src/world/provider/leveldb.ts:140

onShutdown

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

Returns void
Overrides WorldProvider.onShutdown
- Defined in packages/core/src/world/provider/leveldb.ts:59

onStartup

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

Returns void
Overrides WorldProvider.onStartup
- Defined in packages/core/src/world/provider/leveldb.ts:93

readBuffer

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

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.ts:163

readPlayer

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

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.ts:416

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
Inherited from WorldProvider.rentChunk
- Defined in packages/core/src/world/provider/provider.ts:154

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
Inherited from WorldProvider.returnChunk
- Defined in packages/core/src/world/provider/provider.ts:176

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.ts:159

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.ts:297

writeChunkBiomes

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

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.ts:598

writeChunkEntities

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

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.ts:365

writePlayer

writePlayer(player: PlayerLevelStorage): void
Writes a players data to the provider.
Parameters
- player: PlayerLevelStorage
  The player data to write.
Returns void
Overrides WorldProvider.writePlayer
- Defined in packages/core/src/world/provider/leveldb.ts:644

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.ts:461

`Static`buildBiomeStorageKey

buildBiomeStorageKey(cx: number, cz: number, index: number): Buffer
Parameters
- cx: number
- cz: number
- index: number
Returns Buffer
- Defined in packages/core/src/world/provider/leveldb.ts:995

`Static`buildBlockStorageListKey

buildBlockStorageListKey(chunk: Chunk, dimension: Dimension): Buffer
Parameters
- chunk: Chunk
- dimension: Dimension
Returns Buffer
- Defined in packages/core/src/world/provider/leveldb.ts:973

`Static`buildChunkVersionKey

buildChunkVersionKey(cx: number, cz: number, index: number): Buffer
Build a chunk version key for the database.
Parameters
- cx: number
  The chunk X coordinate.
- cz: number
  The chunk Z coordinate.
- index: number
  The dimension index.
Returns Buffer
The buffer key for the chunk version
- Defined in packages/core/src/world/provider/leveldb.ts:909

`Static`buildEntityListKey

buildEntityListKey(chunk: Chunk, dimension: Dimension): Buffer
Build an entity list key for the database.
Parameters
- chunk: Chunk
- dimension: Dimension
  The dimension to build the key for.
Returns Buffer
The buffer key for the actor list
- Defined in packages/core/src/world/provider/leveldb.ts:938

`Static`buildEntityStorageKey

buildEntityStorageKey(uniqueId: bigint): Buffer
Build an entity storage key for the database.
Parameters
- uniqueId: bigint
  The unique identifier of the entity.
Returns Buffer
The buffer key for the entity storage
- Defined in packages/core/src/world/provider/leveldb.ts:962

`Static`buildSubChunkKey

buildSubChunkKey(cx: number, cy: number, cz: number, index: number): Buffer
Build a subchunk key for the database.
Parameters
- cx: number
  The chunk X coordinate.
- cy: number
  The subchunk Y coordinate.
- cz: number
  The chunk Z coordinate.
- index: number
  The dimension index.
Returns Buffer
The buffer key for the subchunk
- Defined in packages/core/src/world/provider/leveldb.ts:876

`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.ts:821

`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.ts:719

Class LevelDBProvider

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LevelDBProvider

Properties

Readonlybarrowers

Readonlychunks

Readonlydb

Readonlyidentifier

Readonlypath

world

Static Readonlyidentifier

Methods

hasChunk

Parameters

Returns boolean

onSave

Returns void

onShutdown

Returns void

onStartup

Returns void

readBuffer

Parameters

Returns Buffer

readChunk

Parameters

Returns Promise<Chunk>

readChunkBiomes

Parameters

Returns BiomeStorage[]

readChunkBlocks

Parameters

Returns BlockLevelStorage[]

readChunkEntities

Parameters

Returns EntityLevelStorage[]

readPlayer

Parameters

Returns null | PlayerLevelStorage

readSubChunk

Parameters

Returns SubChunk

rentChunk

Parameters

Returns void

returnChunk

Parameters

Returns void

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

StaticbuildBiomeStorageKey

`Readonly`barrowers

`Readonly`chunks

`Readonly`db

`Readonly`identifier

`Readonly`path

`Static` `Readonly`identifier

`Static`buildBiomeStorageKey

`Static`buildBlockStorageListKey

`Static`buildChunkVersionKey

`Static`buildEntityListKey

`Static`buildEntityStorageKey

`Static`buildSubChunkKey

`Static`create

`Static`initialize