Class InternalProvider

Hierarchy (View Summary)

WorldProvider
- InternalProvider

Constructors

constructor

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

Properties

`Readonly`barrowers

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

The barrowers map for the provider.

`Readonly`buffers

buffers: Map<string, Buffer<ArrayBufferLike>> = ...

The buffer properties that exist for the world.

`Readonly`chunks

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

The loaded chunks in the provider.

`Readonly`entities

entities: Map<Dimension, Map<bigint, EntityLevelStorage>> = ...

The entities that exist for the world.

`Readonly`identifier

identifier: string = ...

The identifier of the provider.

`Readonly`players

players: Map<string, PlayerLevelStorage> = ...

The players that exist for the world.

world

world: World

The world that the provider belongs to.

`Static` `Readonly`identifier

identifier: "internal"

The identifier of the provider.

Methods

onSave

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

Returns void
Inherited from WorldProvider.onSave
- Defined in packages/core/src/world/provider/provider.ts:65

onShutdown

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

Returns void
Inherited from WorldProvider.onShutdown
- Defined in packages/core/src/world/provider/provider.ts:60

onStartup

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

Returns void
Inherited from WorldProvider.onStartup
- Defined in packages/core/src/world/provider/provider.ts:55

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/internal.ts:38

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/internal.ts:46

readChunkBlocks

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

readChunkEntities

readChunkEntities(_chunk: Chunk, _dimension: Dimension): CompoundTag[]
Parameters
- _chunk: Chunk
- _dimension: Dimension
Returns CompoundTag[]
Inherited from WorldProvider.readChunkEntities
- Defined in packages/core/src/world/provider/provider.ts:103

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/internal.ts:125

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

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

writeBuffer

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

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/internal.ts:68

writeChunkBlocks

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

writeChunkEntities

writeChunkEntities(
    _chunk: Chunk,
    _dimension: Dimension,
    _entities: [bigint, CompoundTag][],
): void
Parameters
- _chunk: Chunk
- _dimension: Dimension
- _entities: [bigint, CompoundTag][]
Returns void
Inherited from WorldProvider.writeChunkEntities
- Defined in packages/core/src/world/provider/provider.ts:110

writePlayer

writePlayer(_uuid: string, _player: CompoundTag): void
Writes a players data to the provider.
Parameters
- _uuid: string
- _player: CompoundTag
Returns void
Inherited from WorldProvider.writePlayer
- Defined in packages/core/src/world/provider/provider.ts:147

`Static`create

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

`Static`initialize

initialize(): Promise<void>
Initializes the provider with the specified properties.

Returns Promise<void>
Overrides WorldProvider.initialize
- Defined in packages/core/src/world/provider/internal.ts:140

Class InternalProvider

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns InternalProvider

Properties

Readonlybarrowers

Readonlybuffers

Readonlychunks

Readonlyentities

Readonlyidentifier

Readonlyplayers

world

Static Readonlyidentifier

Methods

onSave

Returns void

onShutdown

Returns void

onStartup

Returns void

readBuffer

Parameters

Returns Buffer

readChunk

Parameters

Returns Promise<Chunk>

readChunkBlocks

Parameters

Returns BlockLevelStorage[]

readChunkEntities

Parameters

Returns CompoundTag[]

readPlayer

Parameters

Returns null | PlayerLevelStorage

rentChunk

Parameters

Returns void

returnChunk

Parameters

Returns void

writeBuffer

Parameters

Returns void

writeChunk

Parameters

Returns Promise<void>

writeChunkBlocks

Parameters

Returns void

writeChunkEntities

Parameters

Returns void

writePlayer

Parameters

Returns void

Staticcreate

Parameters

Returns Promise<World>

Staticinitialize

Returns Promise<void>

Settings

On This Page

`Readonly`barrowers

`Readonly`buffers

`Readonly`chunks

`Readonly`entities

`Readonly`identifier

`Readonly`players

`Static` `Readonly`identifier

`Static`create

`Static`initialize