Class BaseUniverse

I'm a Minecraft Classic game server, responsible for managing the server lifecycle, connected players and loaded levels.

I coordinate the following core objects:

BasePlayer: Each player is instantiated and registered into my universe. I assign network IDs, manage player lists and emit player lifecycle events.
BaseLevel: I maintain a map of loaded levels, which represent the worlds available on the server. Levels are managed and referenced by name.
BaseHeartbeat: If enabled, I instantiate a heartbeat for server list announcements.

Example: Creating a custom universe by extending BaseUniverse.

import { BaseUniverse } from "classicborne/class/server/BaseUniverse.mjs"
import { CustomPlayer } from "./CustomPlayer.mjs" // Your custom player class

class MyUniverse extends BaseUniverse {
  static playerClass = CustomPlayer
  // Add custom logic.
}

const universe = new MyUniverse({ port: 25565 })
universe.on("playerAdded", (player) => {
  console.log(`Player joined: ${player.username}`)
})

Hierarchy

TypedEmitter
- BaseUniverse

Constructors

constructor

new BaseUniverse(serverConfiguration: any): BaseUniverse
Creates an instance of a BaseUniverse.
Parameters
- serverConfiguration: any
Returns BaseUniverse
Overrides TypedEmitter.constructor
- Defined in class/server/BaseUniverse.mjs:37

Properties

heartbeat

heartbeat: BaseHeartbeat

The heartbeat used for announcing the server to a server list. By default, I load BaseHeartbeat asynchronously if serverConfiguration.postToMainServer is true.

levels

levels: Map<string, BaseLevel<any>>

The currently loaded levels. Indexed by BaseLevel.name.

Use BaseLevel.loadIntoUniverse or BaseLevel.teleportPlayer to load levels into this map.

server

server: Server

A classicborne-server-protocol Server instance.

serverConfiguration

serverConfiguration: any

`Static`defaultMaxListeners

defaultMaxListeners: number

`Static`heartbeatClass

heartbeatClass: Promise<typeof BaseHeartbeat> = ...

The BaseHeartbeat class used for announcing my presence. This is promise as the constructor asynchronously imports the module for the class and assigns it to BaseUniverse.heartbeat.

`Static`playerClass

playerClass: typeof BasePlayer = BasePlayer

The BasePlayer class to instantiate when clients connect to the server.

Methods

addListener

addListener(
 event: U,
 listener: {
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 }[U],
): this
Type Parameters
- U extends "playerAdded" | "playerRemoved"
Parameters
- event: U
- listener: {
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 }[U]
Returns this
Inherited from TypedEmitter.addListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:11

addPlayer

addPlayer(player: BasePlayer): void
Registers the player into the universe, assigning it a network ID and emitting a playerAdded event.
Parameters
- player: BasePlayer
Returns void
Throws
Thrown if a network ID cannot be assigned.
- Defined in class/server/BaseUniverse.mjs:78

emit

emit(
 event: U,
 ...args: Parameters<
 {
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 }[U],
 >,
): boolean
Type Parameters
- U extends "playerAdded" | "playerRemoved"
Parameters
- event: U
- ...args: Parameters<
 {
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 }[U],
 >
Returns boolean
Inherited from TypedEmitter.emit
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:19

eventNames

eventNames(): U[]
Type Parameters
- U extends "playerAdded" | "playerRemoved"
Returns U[]
Inherited from TypedEmitter.eventNames
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:20

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from TypedEmitter.getMaxListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:24

listenerCount

listenerCount(type: "playerAdded" | "playerRemoved"): number
Parameters
- type: "playerAdded" | "playerRemoved"
Returns number
Inherited from TypedEmitter.listenerCount
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:21

listeners

listeners(
 type: U,
): {
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
}[U][]
Type Parameters
- U extends "playerAdded" | "playerRemoved"
Parameters
- type: U
Returns {
playerAdded: (player: BasePlayer) => void;
playerRemoved: (player: BasePlayer) => void;
}[U][]
Inherited from TypedEmitter.listeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:22

off

off(
 event: U,
 listener: {
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 }[U],
): this
Type Parameters
- U extends "playerAdded" | "playerRemoved"
Parameters
- event: U
- listener: {
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 }[U]
Returns this
Inherited from TypedEmitter.off
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:18

on

on(
 event: U,
 listener: {
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 }[U],
): this
Type Parameters
- U extends "playerAdded" | "playerRemoved"
Parameters
- event: U
- listener: {
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 }[U]
Returns this
Inherited from TypedEmitter.on
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:17

once

once(
 event: U,
 listener: {
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 }[U],
): this
Type Parameters
- U extends "playerAdded" | "playerRemoved"
Parameters
- event: U
- listener: {
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 }[U]
Returns this
Inherited from TypedEmitter.once
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:16

prependListener

prependListener(
 event: U,
 listener: {
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 }[U],
): this
Type Parameters
- U extends "playerAdded" | "playerRemoved"
Parameters
- event: U
- listener: {
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 }[U]
Returns this
Inherited from TypedEmitter.prependListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:12

prependOnceListener

prependOnceListener(
 event: U,
 listener: {
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 }[U],
): this
Type Parameters
- U extends "playerAdded" | "playerRemoved"
Parameters
- event: U
- listener: {
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 }[U]
Returns this
Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:13

rawListeners

rawListeners(
 type: U,
): {
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
}[U][]
Type Parameters
- U extends "playerAdded" | "playerRemoved"
Parameters
- type: U
Returns {
playerAdded: (player: BasePlayer) => void;
playerRemoved: (player: BasePlayer) => void;
}[U][]
Inherited from TypedEmitter.rawListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:23

removeAllListeners

removeAllListeners(event?: "playerAdded" | "playerRemoved"): this
Parameters
- Optionalevent: "playerAdded" | "playerRemoved"
Returns this
Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:15

removeListener

removeListener(
 event: U,
 listener: {
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 }[U],
): this
Type Parameters
- U extends "playerAdded" | "playerRemoved"
Parameters
- event: U
- listener: {
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 }[U]
Returns this
Inherited from TypedEmitter.removeListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:14

removePlayer

removePlayer(player: BasePlayer): void
Unregisters the player from the universe, emitting a playerRemoved event. This is called on player disconnect or by BasePlayer.client.disconnect.
Parameters
- player: BasePlayer
Returns void
- Defined in class/server/BaseUniverse.mjs:100

setMaxListeners

setMaxListeners(n: number): this
Parameters
- n: number
Returns this
Inherited from TypedEmitter.setMaxListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:25

Class BaseUniverse

Example: Creating a custom universe by extending BaseUniverse.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BaseUniverse

Properties

heartbeat

levels

server

serverConfiguration

StaticdefaultMaxListeners

StaticheartbeatClass

StaticplayerClass

Methods

addListener

Type Parameters

Parameters

Returns this

addPlayer

Parameters

Returns void

Throws

emit

Type Parameters

Parameters

Returns boolean

eventNames

Type Parameters

Returns U[]

getMaxListeners

Returns number

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns { playerAdded: (player: BasePlayer) => void; playerRemoved: (player: BasePlayer) => void;}[U][]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

prependListener

Type Parameters

Parameters

Returns this

prependOnceListener

Type Parameters

Parameters

Returns this

rawListeners

Type Parameters

Parameters

Returns { playerAdded: (player: BasePlayer) => void; playerRemoved: (player: BasePlayer) => void;}[U][]

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

removePlayer

Parameters

Returns void

setMaxListeners

Parameters

`Static`defaultMaxListeners

`Static`heartbeatClass

`Static`playerClass

Returns {
playerAdded: (player: BasePlayer) => void;
playerRemoved: (player: BasePlayer) => void;
}[U][]

Returns {
playerAdded: (player: BasePlayer) => void;
playerRemoved: (player: BasePlayer) => void;
}[U][]