Class WorldManager

The world manager is responsible level loading, unloading, and general level management.

Implements

Service

Index

Constructors

Methods

addProvider getDefaultWorld getGeneratorManager getProviders getWorldByName getWorlds isWorldLoaded loadWorld removeProvider save unloadWorld

Lifecycle

Constructors

constructor

new WorldManager(server: Server): WorldManager
Parameters
- server: Server
Returns WorldManager
- Defined in packages/prismarine/src/world/WorldManager.ts:34

Methods

addProvider

addProvider(name: string, provider: any): void
Add a provider to the internal providers map.
Parameters
- name: string
  the name of the provider CASE SENSITIVE
- provider: any
  the provider
Returns void
- Defined in packages/prismarine/src/world/WorldManager.ts:81

getDefaultWorld

getDefaultWorld(): undefined | World
Returns undefined | World
- Defined in packages/prismarine/src/world/WorldManager.ts:203

getGeneratorManager

getGeneratorManager(): GeneratorManager
Returns GeneratorManager
- Defined in packages/prismarine/src/world/WorldManager.ts:207

getProviders

getProviders(): Map<string, Provider>
Get all providers.

Returns Map<string, Provider>
- Defined in packages/prismarine/src/world/WorldManager.ts:97

getWorldByName

getWorldByName(folderName: string): null | World
Returns a world by its folder name.
Parameters
- folderName: string
Returns null | World
- Defined in packages/prismarine/src/world/WorldManager.ts:192

getWorlds

getWorlds(): World[]
Returns an array with all worlds.

Returns World[]
- Defined in packages/prismarine/src/world/WorldManager.ts:199

isWorldLoaded

isWorldLoaded(folderName: string): boolean
Returns whatever the world is loaded or not.
Parameters
- folderName: string
Returns boolean
true if the world is loaded, false otherwise
- Defined in packages/prismarine/src/world/WorldManager.ts:180

loadWorld

loadWorld(worldData: WorldData, folderName: string): Promise<World>
Load a world
Parameters
- worldData: WorldData
  the world data including provider key, generator
- folderName: string
  the name of the folder containing the world
Returns Promise<World>
- Defined in packages/prismarine/src/world/WorldManager.ts:117

removeProvider

removeProvider(name: string): void
Remove a provider from the internal providers map.
Parameters
- name: string
  the name of the provider CASE SENSITIVE
Returns void
- Defined in packages/prismarine/src/world/WorldManager.ts:90

save

save(): Promise<void>
Save the world to disk.

Returns Promise<void>
- Defined in packages/prismarine/src/world/WorldManager.ts:104

unloadWorld

unloadWorld(folderName: string): Promise<void>
Unloads a level by its folder name.
Parameters
- folderName: string
Returns Promise<void>
- Defined in packages/prismarine/src/world/WorldManager.ts:159

Lifecycle

disable

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

Signifies that the manager is being disabled and all worlds should be unloaded.

Returns Promise<void>
Implementation of Service.disable
- Defined in packages/prismarine/src/world/WorldManager.ts:70

enable

enable(): Promise<void>
On enable hook, enables the manager and load all worlds.

Returns Promise<void>
Implementation of Service.enable
- Defined in packages/prismarine/src/world/WorldManager.ts:48