Class WorldProvider

Hierarchy (View Summary)

WorldProvider

Index

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:42

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:59

onShutdown

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

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

onStartup

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

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

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:66

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:84

readChunkBlocks

readChunkBlocks(_chunk: Chunk, _dimension: Dimension): BlockLevelStorage[]
Parameters
- _chunk: Chunk
- _dimension: Dimension
Returns BlockLevelStorage[]
- Defined in packages/core/src/world/provider/provider.ts:112

readChunkEntities

readChunkEntities(_chunk: Chunk, _dimension: Dimension): EntityLevelStorage[]
Parameters
- _chunk: Chunk
- _dimension: Dimension
Returns EntityLevelStorage[]
- Defined in packages/core/src/world/provider/provider.ts:97

readPlayer

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

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:75

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:93

writeChunkBlocks

writeChunkBlocks(
    _chunk: Chunk,
    _dimension: Dimension,
    _blocks: BlockLevelStorage[],
): void
Parameters
- _chunk: Chunk
- _dimension: Dimension
- _blocks: BlockLevelStorage[]
Returns void
- Defined in packages/core/src/world/provider/provider.ts:119

writeChunkEntities

writeChunkEntities(
    _chunk: Chunk,
    _dimension: Dimension,
    _entities: EntityLevelStorage[],
): void
Parameters
- _chunk: Chunk
- _dimension: Dimension
- _entities: EntityLevelStorage[]
Returns void
- Defined in packages/core/src/world/provider/provider.ts:104

writePlayer

writePlayer(_player: PlayerLevelStorage): void
Writes a players data to the provider.
Parameters
- _player: PlayerLevelStorage
Returns void
- Defined in packages/core/src/world/provider/provider.ts:140

`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:156

`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:149