classicborne
    Preparing search index...

    Class BaseLevel

    Yet to be documented.

    Hierarchy

    • TypedEmitter
      • BaseLevel
    Index

    Constructors

    Properties

    allowList: any[]

    Yet to be documented.

    blocks: Buffer

    Yet to be documented.

    bounds: Vector3

    Yet to be documented.

    clientDrones: Map<any, any>

    Yet to be documented.

    commandInterpreter: any
    drones: Set<any>

    Yet to be documented.

    players: any[]
    blockset: any[] = []

    Yet to be documented.

    bounds: Vector3 = ...
    commandInterpreterClass: typeof BaseLevelCommandInterpreter = BaseLevelCommandInterpreter

    Yet to be documented.

    commands: any[] = []

    Yet to be documented.

    defaultMaxListeners: number
    environment: {
        cloudsHeight: number;
        edgeHeight: number;
        edgeId: number;
        sidesId: number;
    } = ...

    Yet to be documented.

    standardBounds: Vector3 = ...

    Yet to be documented.

    BaseLevel.bounds

    template: EmptyTemplate = ...

    Yet to be documented.

    Methods

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved" | "loaded" | "unloaded" | "levelLoaded"

      Parameters

      • event: U
      • listener: {
            levelLoaded: () => void;
            loaded: () => void;
            playerAdded: (player: Player) => void;
            playerRemoved: (player: Player) => void;
            unloaded: () => void;
        }[U]

      Returns this

    • Adds a player to the level.

      Parameters

      • player: BasePlayer

        The player to be added.

      • position: number[] = ...
      • orientation: number[] = ...

      Returns void

    • Destroys the level, releasing any resources used for it.

      Parameters

      • OptionalsaveChanges: boolean = true

      Returns Promise<void>

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved" | "loaded" | "unloaded" | "levelLoaded"

      Parameters

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

      Returns boolean

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved" | "loaded" | "unloaded" | "levelLoaded"

      Returns U[]

    • Returns number

    • Parameters

      • type: "playerAdded" | "playerRemoved" | "loaded" | "unloaded" | "levelLoaded"

      Returns number

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved" | "loaded" | "unloaded" | "levelLoaded"

      Parameters

      • type: U

      Returns {
          levelLoaded: () => void;
          loaded: () => void;
          playerAdded: (player: Player) => void;
          playerRemoved: (player: Player) => void;
          unloaded: () => void;
      }[U][]

    • Parameters

      • player: BasePlayer
      • Optionalposition: Vector3 = ...
      • Optionalorientation: Vector2 = ...

      Returns void

      Yet to be documented.

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved" | "loaded" | "unloaded" | "levelLoaded"

      Parameters

      • event: U
      • listener: {
            levelLoaded: () => void;
            loaded: () => void;
            playerAdded: (player: Player) => void;
            playerRemoved: (player: Player) => void;
            unloaded: () => void;
        }[U]

      Returns this

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved" | "loaded" | "unloaded" | "levelLoaded"

      Parameters

      • event: U
      • listener: {
            levelLoaded: () => void;
            loaded: () => void;
            playerAdded: (player: Player) => void;
            playerRemoved: (player: Player) => void;
            unloaded: () => void;
        }[U]

      Returns this

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved" | "loaded" | "unloaded" | "levelLoaded"

      Parameters

      • event: U
      • listener: {
            levelLoaded: () => void;
            loaded: () => void;
            playerAdded: (player: Player) => void;
            playerRemoved: (player: Player) => void;
            unloaded: () => void;
        }[U]

      Returns this

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved" | "loaded" | "unloaded" | "levelLoaded"

      Parameters

      • event: U
      • listener: {
            levelLoaded: () => void;
            loaded: () => void;
            playerAdded: (player: Player) => void;
            playerRemoved: (player: Player) => void;
            unloaded: () => void;
        }[U]

      Returns this

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved" | "loaded" | "unloaded" | "levelLoaded"

      Parameters

      • event: U
      • listener: {
            levelLoaded: () => void;
            loaded: () => void;
            playerAdded: (player: Player) => void;
            playerRemoved: (player: Player) => void;
            unloaded: () => void;
        }[U]

      Returns this

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved" | "loaded" | "unloaded" | "levelLoaded"

      Parameters

      • type: U

      Returns {
          levelLoaded: () => void;
          loaded: () => void;
          playerAdded: (player: Player) => void;
          playerRemoved: (player: Player) => void;
          unloaded: () => void;
      }[U][]

    • Parameters

      • position: Vector3
      • block: number

      Returns void

      Yet to be documented.

    • Parameters

      • Optionalevent: "playerAdded" | "playerRemoved" | "loaded" | "unloaded" | "levelLoaded"

      Returns this

    • Type Parameters

      • U extends "playerAdded" | "playerRemoved" | "loaded" | "unloaded" | "levelLoaded"

      Parameters

      • event: U
      • listener: {
            levelLoaded: () => void;
            loaded: () => void;
            playerAdded: (player: Player) => void;
            playerRemoved: (player: Player) => void;
            unloaded: () => void;
        }[U]

      Returns this

    • Parameters

      • position: Vector3
      • block: number
      • OptionalexcludePlayers: BasePlayer[] = []
      • OptionalsaveToRecord: boolean = true

      Returns void

      Yet to be documented.

    • Parameters

      • n: number

      Returns this

    • Parameters

      • username: string

      Returns boolean

      Yet to be documented.

    • Parameters

      • position: Vector3

      Returns boolean

      Yet to be documented.

    • Parameters

      • command: string

      Returns LevelCommand

      The command class, or null if not found.

      Yet to be documented.

    • Loads a level into a universe instance, creating it if it doesn't exist.

      Parameters

      • universe: BaseUniverse

        The universe to load the level into.

      • spaceName: string

        The identifier of the level.

      • defaults: any

        The default properties for the level.

      Returns Promise<BaseLevel>

      A promise that resolves to the loaded level.

    • Parameters

      • client: Client
      • blockset: number[][]

      Returns void

      Yet to be documented.

    • Teleports the player into the level. If level currently doesn't exist in universe, it'll be created. Levels extending Level are expected to override this method using this pattern:

       static async teleportPlayer(player, spaceName) {
      if (super.teleportPlayer(player) === false) return // Removes player from any levels they are in. If it returns false, the player is still being teleported somewhere.
      Level.loadIntoUniverse(player.universe, spaceName, { // Create the level using its desired defaults.
      levelClass: HubLevel,
      }).then(async (level) => { // Add player after it loads.
      level.addPlayer(player, [60, 8, 4], [162, 254])
      })
      }

      Parameters

      • player: BasePlayer

        The player to teleport.

      • OptionalspaceName: string
      • Optionaldefaults: {} = {}

      Returns Promise<boolean>