Class World

Hierarchy

Emitter<WorldEventSignals>
- World

Constructors

constructor

new World(
    serenity: Serenity,
    provider: WorldProvider,
    properties?: Partial<WorldProperties>,
): World
Parameters
- serenity: Serenity
- provider: WorldProvider
- Optionalproperties: Partial<WorldProperties>
Returns World
Overrides Emitter<WorldEventSignals>.constructor
- Defined in packages/core/src/world/world.ts:115

Properties

`Readonly`blockPalette

blockPalette: BlockPalette = ...

The block palette of the world.

`Readonly`commandPalette

commandPalette: CommandPalette = ...

The command palette of the world.

dayTime

dayTime: number = 0

The current time of day for the world.

`Readonly`dimensions

dimensions: Map<string, Dimension> = ...

The dimensions of the world.

`Readonly`effectPalette

effectPalette: EffectPallete = ...

The effect palette of the world.

`Readonly`entityPalette

entityPalette: EntityPalette = ...

The entity palette of the world.

`Readonly`identifier

identifier: string

The identifier of the world.

`Readonly`itemPalette

itemPalette: ItemPalette = ...

The item palette of the world.

`Readonly`logger

logger: Logger

The logger of the world.

`Readonly`properties

properties: WorldProperties = DefaultWorldProperties

The properties of the world.

`Readonly`provider

provider: WorldProvider

The provider of the world.

`Readonly`scoreboard

scoreboard: Scoreboard = ...

The scoreboard for the world.

`Readonly`serenity

serenity: Serenity

The serenity instance that the world belongs to.

Accessors

currentTick

get currentTick(): bigint
The current tick of the world.

Returns bigint
- Defined in packages/core/src/world/world.ts:106

gamerules

get gamerules(): Partial<Record<GameRule, string | number | boolean>>
The current gamerules values of the world.

Returns Partial<Record<GameRule, string | number | boolean>>
- Defined in packages/core/src/world/world.ts:99

maxListeners

get maxListeners(): number
Returns number
Inherited from Emitter.maxListeners
- Defined in packages/emitter/dist/index.d.ts:10
set maxListeners(value: number): void
Parameters
- value: number
Returns void
Inherited from Emitter.maxListeners
- Defined in packages/emitter/dist/index.d.ts:11

Methods

after

after<K extends keyof WorldEventSignals>(
event: K,
listener: Listener<ForceArray<WorldEventSignals[K]>>,
): this
Type Parameters
- K extends keyof WorldEventSignals
Parameters
- event: K
- listener: Listener<ForceArray<WorldEventSignals[K]>>
Returns this
Inherited from Emitter.after
- Defined in packages/emitter/dist/index.d.ts:19

before

before<K extends keyof WorldEventSignals>(
event: K,
listener: Listener<ForceArray<WorldEventSignals[K]>, boolean>,
): this
Type Parameters
- K extends keyof WorldEventSignals
Parameters
- event: K
- listener: Listener<ForceArray<WorldEventSignals[K]>, boolean>
Returns this
Inherited from Emitter.before
- Defined in packages/emitter/dist/index.d.ts:18

broadcast

broadcast(...packets: DataPacket[]): void
Sends a packet to all players in the world.
Parameters
- ...packets: DataPacket[]
Returns void
- Defined in packages/core/src/world/world.ts:350

broadcastExcept

broadcastExcept(player: Player, ...packets: DataPacket[]): void
Sends a packet to all players in the world except for the specified player.
Parameters
- player: Player
  The player to exclude from the broadcast.
- ...packets: DataPacket[]
  The packets to send.
Returns void
- Defined in packages/core/src/world/world.ts:372

broadcastImmediate

broadcastImmediate(...packets: DataPacket[]): void
Sends a packet to all players in the world immediately. This will bypass the RakNet queue and send the packet immediately.
Parameters
- ...packets: DataPacket[]
  The packets to send.
Returns void
- Defined in packages/core/src/world/world.ts:361

createDimension

createDimension(properties: Partial<DimensionProperties>): false | Dimension
Creates a new dimension with the specified generator and properties.
Parameters
- properties: Partial<DimensionProperties>
  The properties to use for the dimension
Returns false | Dimension
The created dimension, if successful; otherwise, false
- Defined in packages/core/src/world/world.ts:211

emit

emit<K extends keyof WorldEventSignals>(
event: K,
...arguments_: ForceArray<WorldEventSignals[K]>,
): boolean
Type Parameters
- K extends keyof WorldEventSignals
Parameters
- event: K
- ...arguments_: ForceArray<WorldEventSignals[K]>
Returns boolean
Inherited from Emitter.emit
- Defined in packages/emitter/dist/index.d.ts:12

getDefaultGamemode

getDefaultGamemode(): Gamemode
Gets the default gamemode for the world.

Returns Gamemode
The default gamemode.
- Defined in packages/core/src/world/world.ts:400

getDifficulty

getDifficulty(): Difficulty
Get the current difficulty of the world.

Returns Difficulty
The difficulty of the world.
- Defined in packages/core/src/world/world.ts:455

getDimension

getDimension(): Dimension
Get the default dimension for the world

Returns Dimension
- Defined in packages/core/src/world/world.ts:268
getDimension(identifier: string): undefined | Dimension
Get a dimension by the identifier from the world
Parameters
- identifier: string
  The identifier of the dimension
Returns undefined | Dimension
The dimension, if found; otherwise, undefined
- Defined in packages/core/src/world/world.ts:275

getDimensions

getDimensions(): Dimension[]
Get all the dimensions in the world

Returns Dimension[]
An array of dimensions
- Defined in packages/core/src/world/world.ts:297

getEntities

getEntities(): Entity[]
Gets all the entities in the world.

Returns Entity[]
An array of entities.
- Defined in packages/core/src/world/world.ts:313

getPlayers

getPlayers(): Player[]
Gets all the players in the world.

Returns Player[]
An array of players.
- Defined in packages/core/src/world/world.ts:305

on

on<K extends keyof WorldEventSignals>(
event: K,
listener: Listener<ForceArray<WorldEventSignals[K]>>,
): this
Type Parameters
- K extends keyof WorldEventSignals
Parameters
- event: K
- listener: Listener<ForceArray<WorldEventSignals[K]>>
Returns this
Inherited from Emitter.on
- Defined in packages/emitter/dist/index.d.ts:17

once

once<K extends keyof WorldEventSignals>(
event: K,
listener: Listener<ForceArray<WorldEventSignals[K]>>,
): this
Type Parameters
- K extends keyof WorldEventSignals
Parameters
- event: K
- listener: Listener<ForceArray<WorldEventSignals[K]>>
Returns this
Inherited from Emitter.once
- Defined in packages/emitter/dist/index.d.ts:20

onceAfter

onceAfter<K extends keyof WorldEventSignals>(
event: K,
listener: Listener<ForceArray<WorldEventSignals[K]>>,
): this
Type Parameters
- K extends keyof WorldEventSignals
Parameters
- event: K
- listener: Listener<ForceArray<WorldEventSignals[K]>>
Returns this
Inherited from Emitter.onceAfter
- Defined in packages/emitter/dist/index.d.ts:22

onceBefore

onceBefore<K extends keyof WorldEventSignals>(
event: K,
listener: Listener<ForceArray<WorldEventSignals[K]>, boolean>,
): this
Type Parameters
- K extends keyof WorldEventSignals
Parameters
- event: K
- listener: Listener<ForceArray<WorldEventSignals[K]>, boolean>
Returns this
Inherited from Emitter.onceBefore
- Defined in packages/emitter/dist/index.d.ts:21

onTick

onTick(deltaTick: number): void
Ticks the world with a given delta tick.
Parameters
- deltaTick: number
  The delta tick to tick the world with.
Returns void
- Defined in packages/core/src/world/world.ts:154

remove

remove<K extends keyof WorldEventSignals>(
event: K,
listener: Listener<ForceArray<WorldEventSignals[K]>>,
): this
Type Parameters
- K extends keyof WorldEventSignals
Parameters
- event: K
- listener: Listener<ForceArray<WorldEventSignals[K]>>
Returns this
Inherited from Emitter.remove
- Defined in packages/emitter/dist/index.d.ts:23

removeAfter

removeAfter<K extends keyof WorldEventSignals>(
event: K,
listener: Listener<ForceArray<WorldEventSignals[K]>>,
): this
Type Parameters
- K extends keyof WorldEventSignals
Parameters
- event: K
- listener: Listener<ForceArray<WorldEventSignals[K]>>
Returns this
Inherited from Emitter.removeAfter
- Defined in packages/emitter/dist/index.d.ts:25

removeAll

removeAll<K extends keyof WorldEventSignals>(event?: K): this
Type Parameters
- K extends keyof WorldEventSignals
Parameters
- Optionalevent: K
Returns this
Inherited from Emitter.removeAll
- Defined in packages/emitter/dist/index.d.ts:26

removeAllAfter

removeAllAfter<K extends keyof WorldEventSignals>(event?: K): this
Type Parameters
- K extends keyof WorldEventSignals
Parameters
- Optionalevent: K
Returns this
Inherited from Emitter.removeAllAfter
- Defined in packages/emitter/dist/index.d.ts:28

removeAllBefore

removeAllBefore<K extends keyof WorldEventSignals>(event?: K): this
Type Parameters
- K extends keyof WorldEventSignals
Parameters
- Optionalevent: K
Returns this
Inherited from Emitter.removeAllBefore
- Defined in packages/emitter/dist/index.d.ts:27

removeBefore

removeBefore<K extends keyof WorldEventSignals>(
event: K,
listener: Listener<ForceArray<WorldEventSignals[K]>, boolean>,
): this
Type Parameters
- K extends keyof WorldEventSignals
Parameters
- event: K
- listener: Listener<ForceArray<WorldEventSignals[K]>, boolean>
Returns this
Inherited from Emitter.removeBefore
- Defined in packages/emitter/dist/index.d.ts:24

removePath

removePath(path: string): this
Parameters
- path: string
Returns this
Inherited from Emitter.removePath
- Defined in packages/emitter/dist/index.d.ts:29

schedule

schedule(ticks: number): TickSchedule
Schedule an execution of a function after a specified amount of ticks.
Parameters
- ticks: number
  The amount of ticks to wait before the schedule is complete.
Returns TickSchedule
The created tick schedule.
- Defined in packages/core/src/world/world.ts:335

sendMessage

sendMessage(message: string): void
Broadcasts a message to all players in the world.
Parameters
- message: string
  The message to broadcast.
Returns void
- Defined in packages/core/src/world/world.ts:248

setDefaultGamemode

setDefaultGamemode(gamemode: Gamemode): void
Sets the default gamemode for the world.
Parameters
- gamemode: Gamemode
  The gamemode to set.
Returns void
- Defined in packages/core/src/world/world.ts:424

setDifficulty

setDifficulty(difficulty: Difficulty): void
Set the current difficulty of the world.
Parameters
- difficulty: Difficulty
  The difficulty to set.
Returns void
- Defined in packages/core/src/world/world.ts:478

setTimeOfDay

setTimeOfDay(time: number): void
Sets the current time of day for the world.
Parameters
- time: number
  The time of day to set.
Returns void
- Defined in packages/core/src/world/world.ts:382

Class World

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns World

Properties

ReadonlyblockPalette

ReadonlycommandPalette

dayTime

Readonlydimensions

ReadonlyeffectPalette

ReadonlyentityPalette

Readonlyidentifier

ReadonlyitemPalette

Readonlylogger

Readonlyproperties

Readonlyprovider

Readonlyscoreboard

Readonlyserenity

Accessors

currentTick

Returns bigint

gamerules

Returns Partial<Record<GameRule, string | number | boolean>>

maxListeners

Returns number

Parameters

Returns void

Methods

after

Type Parameters

Parameters

Returns this

before

Type Parameters

Parameters

Returns this

broadcast

Parameters

Returns void

broadcastExcept

Parameters

Returns void

broadcastImmediate

Parameters

Returns void

createDimension

Parameters

Returns false | Dimension

emit

Type Parameters

Parameters

Returns boolean

getDefaultGamemode

Returns Gamemode

getDifficulty

Returns Difficulty

getDimension

Returns Dimension

Parameters

Returns undefined | Dimension

getDimensions

Returns Dimension[]

getEntities

Returns Entity[]

getPlayers

Returns Player[]

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

`Readonly`blockPalette

`Readonly`commandPalette

`Readonly`dimensions

`Readonly`effectPalette

`Readonly`entityPalette

`Readonly`identifier

`Readonly`itemPalette

`Readonly`logger

`Readonly`properties

`Readonly`provider

`Readonly`scoreboard

`Readonly`serenity