Class WorldProvider

Hierarchy (View Summary)

WorldProvider
- InternalProvider
- LevelDBProvider

Constructors

constructor

new WorldProvider(..._parameters: unknown[]): WorldProvider
Create a new world provider.
Parameters
- ..._parameters: unknown[]
Returns WorldProvider
- Defined in packages/core/src/world/provider/provider.ts:48

Properties

`Readonly`chunks

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

The cached chunks for the provider.

`Readonly`identifier

identifier: string = ...

The identifier of the provider.

world

world: World

The world that the provider belongs to.

`Static` `Readonly`identifier

identifier: string

The identifier of the provider.

Methods

onSave

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

Returns void
- Defined in packages/core/src/world/provider/provider.ts:65

onShutdown

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

Returns void
- Defined in packages/core/src/world/provider/provider.ts:60

onStartup

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

Returns void
- Defined in packages/core/src/world/provider/provider.ts:55

readAvailableBlocks

readAvailableBlocks(_dimension: Dimension): BlockPosition[]
Reads the available blocks for a specified dimension.
Parameters
- _dimension: Dimension
Returns BlockPosition[]
An array of block positions.
- Defined in packages/core/src/world/provider/provider.ts:171

readAvailableEntities

readAvailableEntities(_dimension: Dimension): bigint[]
Reads the available entities for a specified dimension.
Parameters
- _dimension: Dimension
Returns bigint[]
The available entities.
- Defined in packages/core/src/world/provider/provider.ts:108

readBlock

readBlock(_position: BlockPosition, _dimension: Dimension): BlockEntry
Reads a block from the provider.
Parameters
- _position: BlockPosition
- _dimension: Dimension
Returns BlockEntry
- Defined in packages/core/src/world/provider/provider.ts:196

readBuffer

readBuffer(_key: string): Buffer
Reads a buffer from the provider.
Parameters
- _key: string
Returns Buffer
The buffer data entry.
- Defined in packages/core/src/world/provider/provider.ts:72

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>
- Defined in packages/core/src/world/provider/provider.ts:90

readEntity

readEntity(_uniqueId: bigint, _dimension: Dimension): EntityEntry
Reads an entity from the provider.
Parameters
- _uniqueId: bigint
- _dimension: Dimension
Returns EntityEntry
The entity data.
- Defined in packages/core/src/world/provider/provider.ts:134

readPlayer

readPlayer(_uuid: string, _dimension: Dimension): null | PlayerEntry
Reads a players data from the provider.
Parameters
- _uuid: string
- _dimension: Dimension
Returns null | PlayerEntry
The player data if found, otherwise null.
- Defined in packages/core/src/world/provider/provider.ts:153

writeAvailableBlocks

writeAvailableBlocks(_dimension: Dimension, _positions: BlockPosition[]): void
Writes the available blocks for a specified dimension.
Parameters
- _dimension: Dimension
- _positions: BlockPosition[]
Returns void
- Defined in packages/core/src/world/provider/provider.ts:182

writeAvailableEntities

writeAvailableEntities(_dimension: Dimension, _entities: bigint[]): void
Writes the available entities for a specified dimension.
Parameters
- _dimension: Dimension
- _entities: bigint[]
Returns void
- Defined in packages/core/src/world/provider/provider.ts:119

writeBlock

writeBlock(_block: BlockEntry, _dimension: Dimension): void
Writes a block to the provider.
Parameters
- _block: BlockEntry
- _dimension: Dimension
Returns void
The block data.
- Defined in packages/core/src/world/provider/provider.ts:209

writeBuffer

writeBuffer(_key: string, _value: Buffer): void
Writes a buffer to the provider.
Parameters
- _key: string
- _value: Buffer
Returns void
- Defined in packages/core/src/world/provider/provider.ts:81

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>
- Defined in packages/core/src/world/provider/provider.ts:99

writeEntity

writeEntity(_entity: EntityEntry, _dimension: Dimension): void
Writes an entity to the provider.
Parameters
- _entity: EntityEntry
- _dimension: Dimension
Returns void
- Defined in packages/core/src/world/provider/provider.ts:143

writePlayer

writePlayer(_player: PlayerEntry, _dimension: Dimension): void
Writes a players data to the provider.
Parameters
- _player: PlayerEntry
- _dimension: Dimension
Returns void
- Defined in packages/core/src/world/provider/provider.ts:162

`Static`create

create(
    _serenity: Serenity,
    _properties: WorldProviderProperties,
    _worldProperties?: Partial<WorldProperties>,
): Promise<World>
Parameters
- _serenity: Serenity
- _properties: WorldProviderProperties
- Optional_worldProperties: Partial<WorldProperties>
Returns Promise<World>
- Defined in packages/core/src/world/provider/provider.ts:225

`Static`initialize

initialize(
_serenity: Serenity,
_properties: WorldProviderProperties,
): Promise<void>
Initializes the provider with the specified properties.
Parameters
- _serenity: Serenity
- _properties: WorldProviderProperties
Returns Promise<void>
- Defined in packages/core/src/world/provider/provider.ts:218