Class Serenity

Hierarchy

Emitter<WorldEventSignals & ServerEvents>
- Serenity

Constructors

constructor

new Serenity(properties?: Partial<ServerProperties>): Serenity
Creates a new serenity server with the specified properties
Parameters
- Optionalproperties: Partial<ServerProperties>
  The properties to use for the server
Returns Serenity
Overrides Emitter<WorldEventSignals & ServerEvents>.constructor
- Defined in packages/core/src/serenity.ts:154

Properties

`Readonly`commandPalette

commandPalette: CommandPalette = ...

The global commands registry for the server. The commands will register on every world that is created.

`Readonly`console

console: ConsoleInterface = ...

The console command interface for the server

currentTick

currentTick: bigint = 0n

The current tick of the server

`Readonly`generators

generators: Map<string, typeof TerrainGenerator> = ...

The registered terrain generators that are available to the server

`Readonly`logger

logger: Logger = ...

The logger instance for the server

`Readonly`network

network: Network

The network handler for the server

`Readonly`permissions

permissions: IPermissions<PermissionGroup, PermissionMember>

The permissions interface for the server.

`Readonly`players

players: Map<Connection, Player> = ...

The players that are currently connected to the server

`Readonly`properties

properties: SerenityProperties = DefaultSerenityProperties

The properties that are being used for the server

`Readonly`providers

providers: Map<typeof WorldProvider, WorldProviderProperties> = ...

The registered providers and properties that are available to the server

`Readonly`resourcePacks

resourcePacks: ResourcePackManager

The resource pack manager for the server.

`Readonly`schedules

schedules: Set<TickSchedule> = ...

The tick schedules that are currently active on the server. These schedules will be executed when the server ticks.

`Readonly`simulations

simulations: Set<Simulation> = ...

The simulations that are currently active on the server. These simulations will be executed at a higher frequency than the server ticks.

state

state: ServerState = ServerState.StartingUp

The current state of the server, whether it is starting up, running, or shutting down

ticks

ticks: number[] = []

The ticks that have been recorded by the server

tps

tps: number = 0

The current ticks per second of the server

`Readonly`worlds

worlds: Map<string, World> = ...

The worlds that are currently loaded on the server

Accessors

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

before

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

createWorld

createWorld(
provider: typeof WorldProvider,
properties?: Partial<WorldProperties>,
): Promise<null | World>
Creates a new world using the specified provider
Parameters
- provider: typeof WorldProvider
  The provider to use for the world
- Optionalproperties: Partial<WorldProperties>
  The properties to use for the world
Returns Promise<null | World>
The created world, if successful; otherwise, false
- Defined in packages/core/src/serenity.ts:491

emit

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

getDimension

getDimension(world: World, identifier: string): null | Dimension
Gets a dimension from a world by its identifier
Parameters
- world: World
  The world to get the dimension from
- identifier: string
  The identifier of the dimension
Returns null | Dimension
The dimension, if found; otherwise, null
- Defined in packages/core/src/serenity.ts:572

getDimensions

getDimensions(world: World): Dimension[]
Gets all the dimensions that are currently loaded in a world
Parameters
- world: World
  The world to get the dimensions from
Returns Dimension[]
An array of dimensions
- Defined in packages/core/src/serenity.ts:581

getGenerator

getGenerator(identifier: string): null | typeof TerrainGenerator
Parameters
- identifier: string
Returns null | typeof TerrainGenerator
- Defined in packages/core/src/serenity.ts:481

getPermissionMember

getPermissionMember(player: string | Player): PermissionMember
Gets the permission member for the specified player; creates a new member if one does not exist
Parameters
- player: string | Player
  The player to get the member permission for.
Returns PermissionMember
The member permission for the player.
- Defined in packages/core/src/serenity.ts:642

getPlayerByConnection

getPlayerByConnection(connection: Connection): null | Player
Gets a player by their raknet connection
Parameters
- connection: Connection
  The connection to get the player from
Returns null | Player
The player, if found; otherwise, null
- Defined in packages/core/src/serenity.ts:590

getPlayerByUsername

getPlayerByUsername(username: string): null | Player
Gets a player by their username
Parameters
- username: string
  The username to get the player from
Returns null | Player
The player, if found; otherwise, null
- Defined in packages/core/src/serenity.ts:610

getPlayerByUuid

getPlayerByUuid(uuid: string): null | Player
Gets a player by their uuid
Parameters
- uuid: string
  The uuid to get the player from
Returns null | Player
The player, if found; otherwise, null
- Defined in packages/core/src/serenity.ts:623

getPlayerByXuid

getPlayerByXuid(xuid: string): null | Player
Gets a player by their xuid
Parameters
- xuid: string
  The xuid to get the player from
Returns null | Player
The player, if found; otherwise, null
- Defined in packages/core/src/serenity.ts:599

getPlayers

getPlayers(): Player[]
Gets all the players that are currently connected to the server

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

getWorld

getWorld(): World
Returns World
- Defined in packages/core/src/serenity.ts:519
getWorld(identifier: string): null | World
Parameters
- identifier: string
Returns null | World
- Defined in packages/core/src/serenity.ts:520

getWorlds

getWorlds(): World[]
Gets all the worlds that are currently loaded on the server

Returns World[]
An array of worlds
- Defined in packages/core/src/serenity.ts:536

on

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

once

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

onceAfter

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

onceBefore

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

readPermissions

readPermissions(path: string): IPermissions
Parameters
- path: string
Returns IPermissions
- Defined in packages/core/src/serenity.ts:704

readProperties

readProperties(path: string): Partial<ServerProperties>
Reads the server properties from the specified path
Parameters
- path: string
  The path to read the server properties from
Returns Partial<ServerProperties>
The server properties that were read
- Defined in packages/core/src/serenity.ts:671

registerGenerator

registerGenerator(generator: typeof TerrainGenerator): boolean
Parameters
- generator: typeof TerrainGenerator
Returns boolean
- Defined in packages/core/src/serenity.ts:459

registerProvider

registerProvider(
provider: typeof WorldProvider,
properties?: Partial<WorldProviderProperties>,
): boolean
Registers a provider with the server
Parameters
- provider: typeof WorldProvider
  The provider to register
- Optionalproperties: Partial<WorldProviderProperties>
  The properties to use for the provider
Returns boolean
Whether the provider was successfully registered or not
- Defined in packages/core/src/serenity.ts:415

registerWorld

registerWorld(world: World): boolean
Parameters
- world: World
Returns boolean
- Defined in packages/core/src/serenity.ts:540

remove

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

removeAfter

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

removeAll

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

removeAllAfter

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

removeAllBefore

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

removeBefore

removeBefore<K extends (keyof WorldEventSignals) | (keyof ServerEvents)>(
    event: K,
    listener: Listener<
        ForceArray<(WorldEventSignals & ServerEvents)[K]>,
        boolean,
    >,
): this
Type Parameters
- K extends (keyof WorldEventSignals) | (keyof ServerEvents)
Parameters
- event: K
- listener: Listener<ForceArray<(WorldEventSignals & ServerEvents)[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

setMotd

setMotd(motd: string): void
Sets the message of the day for the server
Parameters
- motd: string
  The message of the day to set
Returns void
- Defined in packages/core/src/serenity.ts:405

simulate

simulate(frequency: number, callback: SimulationCallback): SimulationInstance
Simulates the callback at the specified frequency. This will run at a higher frequency then minecraft ticks.
Parameters
- frequency: number
  Simulation frequency in seconds. The server game loop is capped at 100 simulations per second.
- callback: SimulationCallback
  The callback to run when its time to simulate.
Returns SimulationInstance
An object containing some controls for the simulation.
- Defined in packages/core/src/serenity.ts:745

start

start(): void
Starts the server and begins listening for incoming connections

Returns void
- Defined in packages/core/src/serenity.ts:246

stop

stop(): void
Stops the server and closes all connections

Returns void
- Defined in packages/core/src/serenity.ts:371

writePermissions

writePermissions(path: string): undefined | false
Parameters
- path: string
Returns undefined | false
- Defined in packages/core/src/serenity.ts:717

writeProperties

writeProperties(path: string): undefined | false
Writes the server properties to the specified path
Parameters
- path: string
  The path to write the server properties to
Returns undefined | false
Whether the properties were successfully written or not
- Defined in packages/core/src/serenity.ts:688

Class Serenity

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Serenity

Properties

ReadonlycommandPalette

Readonlyconsole

currentTick

Readonlygenerators

Readonlylogger

Readonlynetwork

Readonlypermissions

Readonlyplayers

Readonlyproperties

Readonlyproviders

ReadonlyresourcePacks

Readonlyschedules

Readonlysimulations

state

ticks

tps

Readonlyworlds

Accessors

maxListeners

Returns number

Parameters

Returns void

Methods

after

Type Parameters

Parameters

Returns this

before

Type Parameters

Parameters

Returns this

createWorld

Parameters

Returns Promise<null | World>

emit

Type Parameters

Parameters

Returns boolean

getDimension

Parameters

Returns null | Dimension

getDimensions

Parameters

Returns Dimension[]

getGenerator

Parameters

Returns null | typeof TerrainGenerator

getPermissionMember

Parameters

Returns PermissionMember

getPlayerByConnection

Parameters

Returns null | Player

getPlayerByUsername

Parameters

Returns null | Player

getPlayerByUuid

Parameters

Returns null | Player

getPlayerByXuid

Parameters

Returns null | Player

getPlayers

Returns Player[]

getWorld

Returns World

Parameters

Returns null | World

`Readonly`commandPalette

`Readonly`console

`Readonly`generators

`Readonly`logger

`Readonly`network

`Readonly`permissions

`Readonly`players

`Readonly`properties

`Readonly`providers

`Readonly`resourcePacks

`Readonly`schedules

`Readonly`simulations

`Readonly`worlds