classicborne
    Preparing search index...

    Class BaseUniverse

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

    I think you'll find that the universe pretty much covers everything. (Shut up and get on my horse.)
    Amazing Horse (20xx)

    I coordinate the following core objects:

    I'm an event emitter. I emit the following events:

    • playerAdded (player): When a player joins.
    • playerRemove (player): When a player disconnects.

    Like other object in the classicborne ecosystem, universes are usually subclasses of me.

    My class-sided fields are defaulted to base class implementations. For example, I initialize new instances of a Player using my playerClass static field. Such class-sided members are intended to be overwritten by my subclasses. This is known as "dependency injection".

    I provide the following class fields for dependency injection:

    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
    Index

    Constructors

    constructor

    Properties

    heartbeat levels server serverConfiguration defaultMaxListeners heartbeatClass playerClass

    Methods

    addListener addPlayer emit eventNames getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener removePlayer setMaxListeners

    Constructors

    Properties

    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: 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

    A classicborne-server-protocol Server instance.

    serverConfiguration: any
    defaultMaxListeners: number
    heartbeatClass: Promise<typeof BaseHeartbeat> = ...

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

    playerClass: typeof BasePlayer = BasePlayer

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

    Methods

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved"

      Parameters

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

      Returns this

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved"

      Parameters

      • event: U
      • ...args: Parameters<
            {
                playerAdded: (player: BasePlayer) => void;
                playerRemoved: (player: BasePlayer) => void;
            }[U],
        >

      Returns boolean

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved"

      Returns U[]

    • Returns number

    • Parameters

      • type: "playerAdded" | "playerRemoved"

      Returns number

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved"

      Parameters

      • type: U

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

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved"

      Parameters

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

      Returns this

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved"

      Parameters

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

      Returns this

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved"

      Parameters

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

      Returns this

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved"

      Parameters

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

      Returns this

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved"

      Parameters

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

      Returns this

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved"

      Parameters

      • type: U

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

    • Parameters

      • Optionalevent: "playerAdded" | "playerRemoved"

      Returns this

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved"

      Parameters

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

      Returns this

    • Parameters

      • n: number

      Returns this

    Settings

    Member Visibility

    On This Page

    EventsSubclassing
    Constructors
    Properties
    Methods