Class FileSystemProvider

Hierarchy (View Summary)

WorldProvider
- FileSystemProvider

Constructors

constructor

new FileSystemProvider(path: string): FileSystemProvider
Create a new filesystem provider.
Parameters
- path: string
  The path to the world directory.
Returns FileSystemProvider
Overrides WorldProvider.constructor
- Defined in packages/core/src/world/provider/filesystem.ts:46

Properties

`Readonly`barrowers

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

The barrowers map for the provider.

`Readonly`chunks

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

The cached chunks for the provider.

`Readonly`identifier

identifier: string = ...

The identifier of the provider.

`Readonly`path

path: string

The path to the world directory.

world

world: World

The world that the provider belongs to.

`Static` `Readonly`identifier

identifier: string = "filesystem"

The identifier of the provider.

Methods

onSave

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

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

onShutdown

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

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

onStartup

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

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

readBuffer

readBuffer(_key: string): Buffer
Reads a buffer from the provider.
Parameters
- _key: string
Returns Buffer
The buffer data entry.
Inherited from WorldProvider.readBuffer
- 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
  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/filesystem.ts:123

readChunkBlocks

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

readChunkEntities

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

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/filesystem.ts:243

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, _value: Buffer): void
Writes a buffer to the provider.
Parameters
- _key: string
- _value: Buffer
Returns void
Inherited from WorldProvider.writeBuffer
- 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
  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/filesystem.ts:209

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/filesystem.ts:385

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/filesystem.ts:312

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/filesystem.ts:263

`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/filesystem.ts:562

`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/filesystem.ts:727

`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/filesystem.ts:425

`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/filesystem.ts:649

Class FileSystemProvider

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FileSystemProvider

Properties

Readonlybarrowers

Readonlychunks

Readonlyidentifier

Readonlypath

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 | CompoundTag

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>

StaticcreateFromGivenPath

Parameters

Returns Promise<World>

Staticinitialize

Parameters

Returns Promise<void>

StaticloadFromExistingPath

Parameters

Returns Promise<World>

Settings

On This Page

`Readonly`barrowers

`Readonly`chunks

`Readonly`identifier

`Readonly`path

`Static` `Readonly`identifier

`Static`create

`Static`createFromGivenPath

`Static`initialize

`Static`loadFromExistingPath