Class BaseProvider`Abstract`

Implements

default

Index

Constructors

Properties

path server world

Methods

getPath getServer getWorld readChunk setWorld writeChunk

Lifecycle

Constructors

constructor

new BaseProvider(path: string, server: Server): BaseProvider
Parameters
- path: string
- server: Server
Returns BaseProvider
- Defined in packages/prismarine/src/world/providers/BaseProvider.ts:13

Properties

`Protected`path

path: string

`Protected`server

server: Server

`Protected`world

world: World

Methods

getPath

getPath(): string
Returns the path to the world folder.

Returns string
Implementation of Provider.getPath
- Defined in packages/prismarine/src/world/providers/BaseProvider.ts:46

getServer

getServer(): Server
Returns Server
- Defined in packages/prismarine/src/world/providers/BaseProvider.ts:39

getWorld

getWorld(): World
Returns World
- Defined in packages/prismarine/src/world/providers/BaseProvider.ts:24

`Abstract`readChunk

readChunk(
    cx: number,
    cz: number,
    seed: number,
    generator: Generator,
    config?: any,
): Promise<Chunk>
Returns a chunk decoded from the provider.
Parameters
- cx: number
  the chunk x coordinate.
- cz: number
  the chunk y coordinate.
- seed: number
- generator: Generator
- Optionalconfig: any
Returns Promise<Chunk>
Implementation of Provider.readChunk
- Defined in packages/prismarine/src/world/providers/BaseProvider.ts:56

setWorld

setWorld(world: World): void
Parameters
- world: World
Returns void
- Defined in packages/prismarine/src/world/providers/BaseProvider.ts:21

`Abstract`writeChunk

writeChunk(chunk: Chunk): Promise<void>
Writes a chunk.
Parameters
- chunk: Chunk
  the chunk data.
Returns Promise<void>
Implementation of Provider.writeChunk
- Defined in packages/prismarine/src/world/providers/BaseProvider.ts:63

Lifecycle

disable

disable(): Promise<void>
On disable hook.

Returns Promise<void>
Implementation of Provider.disable
- Defined in packages/prismarine/src/world/providers/BaseProvider.ts:37

enable

enable(): Promise<void>
On enable hook.

Returns Promise<void>
Implementation of Provider.enable
- Defined in packages/prismarine/src/world/providers/BaseProvider.ts:32