Class World

Implements

Service

Constructors

constructor

new World(__namedParameters: WorldData): World
Parameters
- __namedParameters: WorldData
Returns World
- Defined in packages/prismarine/src/world/World.ts:77

Methods

addEntity

addEntity(entity: Entity): Promise<void>
Adds an entity to the level.
Parameters
- entity: Entity
  The entity to add.
Returns Promise<void>
- Defined in packages/prismarine/src/world/World.ts:395

getBlock

getBlock(x: number, y: number, z: number, layer?: number): Promise<Block>
Returns a block instance in the given world position.
Parameters
- x: number
  block x
- y: number
  block y
- z: number
  block z
- Optionallayer: number = 0
  block storage layer (0 for blocks, 1 for liquids)
Returns Promise<Block>
- Defined in packages/prismarine/src/world/World.ts:189

getChunk

getChunk(cx: number, cz: number): Promise<Chunk>
Returns the chunk in the specifies x and z, if the chunk doesn't exists it is generated.
Parameters
- cx: number
- cz: number
Returns Promise<Chunk>
- Defined in packages/prismarine/src/world/World.ts:201

getChunkAt

getChunkAt(x: Vector3): Promise<Chunk>
Returns a chunk from a block position's x and z coordinates.
Parameters
- x: Vector3
Returns Promise<Chunk>
- Defined in packages/prismarine/src/world/World.ts:242
getChunkAt(x: number, z: number): Promise<Chunk>
Returns a chunk from a block position's x and z coordinates.
Parameters
- x: number
- z: number
Returns Promise<Chunk>
- Defined in packages/prismarine/src/world/World.ts:243

getEntities

getEntities(): Entity[]
Get all entities in this world.

Returns Entity[]
the entities.
- Defined in packages/prismarine/src/world/World.ts:417

getFormattedName

getFormattedName(): string
Returns string
- Defined in packages/prismarine/src/world/World.ts:476

getGameruleManager

getGameruleManager(): GameruleManager
Returns GameruleManager
- Defined in packages/prismarine/src/world/World.ts:452

getGenerator

getGenerator(): Generator
Returns Generator
- Defined in packages/prismarine/src/world/World.ts:158

getName

getName(): string
Returns string
- Defined in packages/prismarine/src/world/World.ts:473

getPlayerData

getPlayerData(player: Player): Promise<Partial<WorldPlayerData>>
Get the player data for a player.
Parameters
- player: Player
  The player to get the data for.
Returns Promise<Partial<WorldPlayerData>>
The player data.
- Defined in packages/prismarine/src/world/World.ts:535

getPlayers

getPlayers(): Player[]
Get all players in this world.

Returns Player[]
the players.
- Defined in packages/prismarine/src/world/World.ts:424

getProvider

getProvider(): any
Returns any
- Defined in packages/prismarine/src/world/World.ts:464

getSeed

getSeed(): number
Returns number
- Defined in packages/prismarine/src/world/World.ts:480

getServer

getServer(): Server
Returns Server
The server instance.
- Defined in packages/prismarine/src/world/World.ts:596

getSpawnPosition

getSpawnPosition(): Promise<Vector3>
Returns the world default spawn position.

Returns Promise<Vector3>
- Defined in packages/prismarine/src/world/World.ts:255

getTicks

getTicks(): number
Returns number
- Defined in packages/prismarine/src/world/World.ts:456

getUUID

getUUID(): string
Returns string
- Defined in packages/prismarine/src/world/World.ts:469

loadChunk

loadChunk(x: number, z: number, _ignoreWarn?: boolean): Promise<Chunk>
Loads a chunk in a given x and z and returns its.
Parameters
- x: number
  x coordinate.
- z: number
  z coordinate.
- Optional_ignoreWarn: boolean
Returns Promise<Chunk>
- Defined in packages/prismarine/src/world/World.ts:213

removeEntity

removeEntity(entity: Entity): Promise<void>
Removes an entity from the level.
Parameters
- entity: Entity
  The entity to remove.
Returns Promise<void>
- Defined in packages/prismarine/src/world/World.ts:406

save

save(): Promise<void>
Returns Promise<void>
- Defined in packages/prismarine/src/world/World.ts:443

saveChunks

saveChunks(): Promise<void>
Saves changed chunks into disk.

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

saveLevelData

saveLevelData(): Promise<void>
Returns Promise<void>
- Defined in packages/prismarine/src/world/World.ts:498

savePlayerData

savePlayerData(player: Player): Promise<void>
Parameters
- player: Player
Returns Promise<void>
- Defined in packages/prismarine/src/world/World.ts:565

sendTime

sendTime(): Promise<void>
Sends the current time to all players in the world.

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

sendWorldEvent

sendWorldEvent(
    position: null | Vector3,
    event: WorldEvent,
    data: number,
): Promise<void>
Sends a world event packet to all the viewers in the position chunk.
Parameters
- position: null | Vector3
  world position.
- event: WorldEvent
  event identifier.
- data: number
  event data.
Returns Promise<void>
- Defined in packages/prismarine/src/world/World.ts:229

setSpawnPosition

setSpawnPosition(pos: Vector3): void
Set the world's spawn position.
Parameters
- pos: Vector3
  The position.
Returns void
- Defined in packages/prismarine/src/world/World.ts:269

setTicks

setTicks(tick: number): void
Parameters
- tick: number
Returns void
- Defined in packages/prismarine/src/world/World.ts:460

update

update(tick: number): Promise<void>
Called every tick.
Parameters
- tick: number
Returns Promise<void>
- Defined in packages/prismarine/src/world/World.ts:167

useItemOn

useItemOn(
    itemInHand: null | Item | Block,
    blockPosition: Vector3,
    face: number,
    clickPosition: Vector3,
    player: Player,
): Promise<void>
Parameters
- itemInHand: null | Item | Block
- blockPosition: Vector3
- face: number
- clickPosition: Vector3
- player: Player
Returns Promise<void>
- Defined in packages/prismarine/src/world/World.ts:274

Lifecycle

disable

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

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

enable

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

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