Class BaseLevel<E>

Todo

Yet to be documented.

Template: E

Type Parameters

E extends Record<string, any>

Hierarchy

TypedEmitter
- BaseLevel

Constructors

constructor

new BaseLevel<E extends Record<string, any>>(
bounds: Vector3,
blocks: Buffer<ArrayBufferLike>,
): BaseLevel<E>
Initializes a new instance of the BaseLevel class.
Type Parameters
- E extends Record<string, any>
Parameters
- bounds: Vector3
- blocks: Buffer<ArrayBufferLike>
Returns BaseLevel<E>
Overrides TypedEmitter.constructor
- Defined in class/level/BaseLevel.mjs:31

Properties

allowList

allowList: string[]

Usernames of who is allowed to build in the level. BaseLevel.userHasPermission checks against this list. If empty, everyone is allowed.

blocking

blocking: boolean

blocks

blocks: Buffer<ArrayBufferLike>

The buffer representing the level's blocks.

bounds

bounds: Vector3

The bounds of the level.

changeRecord

changeRecord: ChangeRecord | NullChangeRecord

clientDrones

clientDrones: Map<Client, Drone>

Drones which are linked to clients in the level.

commandInterpreter

commandInterpreter: BaseLevelCommandInterpreter

drones

drones: Set<Drone>

The set of drones currently in the level.

loading

loading: boolean

players

players: BasePlayer[]

The players currently in the level.

`Static`blockset

blockset: number[][] = []

Defines the block set used in the level.

`Static`bounds

bounds: Vector3 = ...

`Static`commandInterpreterClass

commandInterpreterClass: typeof BaseLevelCommandInterpreter = BaseLevelCommandInterpreter

The default BaseLevelCommandInterpreter class for the level.

`Static`commands

commands: any[] = []

Todo

Yet to be documented.

`Static`defaultMaxListeners

defaultMaxListeners: number

`Static`environment

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

Defines the environmental properties of the level, such as sky and cloud settings.

Todo

Expose types from classicborne-server-protocol for better documentation.

`Static`standardBounds

standardBounds: Vector3 = ...

Deprecated. Use BaseLevel.bounds instead.

Deprecated

`Static`template

template: EmptyTemplate = ...

The template used to generate the level's blocks.

Methods

addDrone

addDrone(drone: Drone): void
Adds a drone to the level.
Parameters
- drone: Drone
  The drone to be added.
Returns void
- Defined in class/level/BaseLevel.mjs:106

addListener

addListener(
 event: U,
 listener: (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
 )[U],
): this
Type Parameters
- U extends string | number | symbol
Parameters
- event: U
- listener: (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
 )[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, position?: number[], orientation?: number[]): void
Adds a player to the level.
Parameters
- player: BasePlayer
  The player to be added.
- position: number[] = ...
- orientation: number[] = ...
Returns void
- Defined in class/level/BaseLevel.mjs:116

dispose

dispose(saveChanges?: boolean): Promise<void>
Destroys the level, releasing any resources used for it.
Parameters
- OptionalsaveChanges: boolean = true
 If true, I will flush any pending block changes to my ChangeRecord before disposing it. Default is true
Returns Promise<void>
- Defined in class/level/BaseLevel.mjs:235

emit

emit(
 event: U,
 ...args: Parameters<
 (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
 )[U],
 >,
): boolean
Type Parameters
- U extends string | number | symbol
Parameters
- event: U
- ...args: Parameters<
 (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
 )[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 string | number | symbol
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

getBlock

getBlock(position: Vector3): number
Gets the block type at the specified position in the level.
Parameters
- position: Vector3
  The position to get the block from.
Returns number
The block type at the specified position.
- Defined in class/level/BaseLevel.mjs:195

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"
        | "loaded"
        | "unloaded"
        | "levelLoaded"
        | keyof E,
): number
Parameters
- type:
      | "playerAdded"
      | "playerRemoved"
      | "loaded"
      | "unloaded"
      | "levelLoaded"
      | keyof E
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,
): (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
)[U][]
Type Parameters
- U extends string | number | symbol
Parameters
- type: U
Returns (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
)[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

loadPlayer

loadPlayer(player: BasePlayer, position?: Vector3, orientation?: Vector2): void
Sends the level data to the specified player. This is typically called on BaseLevel.addPlayer.
Parameters
- player: BasePlayer
- Optionalposition: Vector3 = ...
  Default is [0,0,0]
- Optionalorientation: Vector2 = ...
  Default is [0,0]
Returns void
- Defined in class/level/BaseLevel.mjs:133

off

off(
 event: U,
 listener: (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
 )[U],
): this
Type Parameters
- U extends string | number | symbol
Parameters
- event: U
- listener: (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
 )[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: (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
 )[U],
): this
Type Parameters
- U extends string | number | symbol
Parameters
- event: U
- listener: (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
 )[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: (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
 )[U],
): this
Type Parameters
- U extends string | number | symbol
Parameters
- event: U
- listener: (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
 )[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: (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
 )[U],
): this
Type Parameters
- U extends string | number | symbol
Parameters
- event: U
- listener: (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
 )[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: (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
 )[U],
): this
Type Parameters
- U extends string | number | symbol
Parameters
- event: U
- listener: (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
 )[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,
): (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
)[U][]
Type Parameters
- U extends string | number | symbol
Parameters
- type: U
Returns (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
)[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

rawSetBlock

rawSetBlock(position: Vector3, block: number): void
Sets a block at the specified position in the level without notifying players.
Parameters
- position: Vector3
  The position to set the block at.
- block: number
  The block type to set.
Returns void
- Defined in class/level/BaseLevel.mjs:187

reload

reload(): void
Reloads all players in the level, typically used to refresh the level's state.

Returns void
- Defined in class/level/BaseLevel.mjs:156

removeAllListeners

removeAllListeners(
    event?:
        | "playerAdded"
        | "playerRemoved"
        | "loaded"
        | "unloaded"
        | "levelLoaded"
        | keyof E,
): this
Parameters
- Optionalevent:
      | "playerAdded"
      | "playerRemoved"
      | "loaded"
      | "unloaded"
      | "levelLoaded"
      | keyof E
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

removeDrone

removeDrone(drone: Drone): void
Removes a drone from the level.
Parameters
- drone: Drone
  The drone to be removed.
Returns void
- Defined in class/level/BaseLevel.mjs:98

removeListener

removeListener(
 event: U,
 listener: (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
 )[U],
): this
Type Parameters
- U extends string | number | symbol
Parameters
- event: U
- listener: (
 {
 levelLoaded: () => void;
 loaded: () => void;
 playerAdded: (player: BasePlayer) => void;
 playerRemoved: (player: BasePlayer) => void;
 unloaded: () => void;
 } & E
 )[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
Removes a player from the level.
Parameters
- player: BasePlayer
  The player to be removed.
Returns void
- Defined in class/level/BaseLevel.mjs:84

sendDrones

sendDrones(player: BasePlayer): void
Sends all drones in the level to the specified player.
Parameters
- player: BasePlayer
  The player to send the drones to.
Returns void
- Defined in class/level/BaseLevel.mjs:75

setBlock

setBlock(
    position: Vector3,
    block: number,
    excludePlayers?: BasePlayer[],
    saveToRecord?: boolean,
): void
Sets a block at the specified position in the level.
Parameters
- position: Vector3
  The position to set the block at.
- block: number
  The block type to set.
- OptionalexcludePlayers: BasePlayer[] = []
  Default is []
- OptionalsaveToRecord: boolean = true
  Default is true
Returns void
- Defined in class/level/BaseLevel.mjs:172

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

userHasPermission

userHasPermission(username: string): boolean
Checks if a user has permission to edit the level.
Parameters
- username: string
  The username to check.
Returns boolean
Whether the user has permission.
- Defined in class/level/BaseLevel.mjs:214

withinLevelBounds

withinLevelBounds(position: Vector3): boolean
Checks if a position is within the level bounds.
Parameters
- position: Vector3
  The position to check.
Returns boolean
Whether the position is within the level bounds.
- Defined in class/level/BaseLevel.mjs:203

`Static`getCommandClassFromName

getCommandClassFromName(command: string): LevelCommand
Parameters
- command: string
Returns LevelCommand
The command class, or null if not found.

Todo
Yet to be documented.
- Defined in class/level/BaseLevel.mjs:224

`Static`loadIntoUniverse

loadIntoUniverse(
 universe: BaseUniverse,
 spaceName: string,
 defaults: any,
): Promise<BaseLevel<any>>
Loads a level into a BaseUniverse 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. This will be used for BaseUniverse.levels.
- defaults: any
 The default properties for the level.
Returns Promise<BaseLevel<any>>
A promise that resolves to the loaded level.
- Defined in class/level/BaseLevel.mjs:288

`Static`sendBlockset

sendBlockset(client: Client, blockset: number[][]): void
Sends a block set to a client.
Parameters
- client: Client
  The client to send the block set to.
- blockset: number[][]
  The block set to send.
Returns void
- Defined in class/level/BaseLevel.mjs:249

`Static`teleportPlayer

teleportPlayer(
 player: BasePlayer,
 spaceName?: string,
 defaults?: {},
): Promise<boolean>

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
The identifier of the level to teleport to. Default is null
Optionaldefaults: {} = {}
Default is {}

Class BaseLevel<E>

Todo

Template: E

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BaseLevel<E>

Properties

allowList

blocking

blocks

bounds

changeRecord

clientDrones

commandInterpreter

drones

loading

players

Staticblockset

Staticbounds

StaticcommandInterpreterClass

Staticcommands

Todo

StaticdefaultMaxListeners

Staticenvironment

Todo

StaticstandardBounds

Deprecated

Statictemplate

Methods

addDrone

Parameters

Returns void

addListener

Type Parameters

Parameters

Returns this

addPlayer

Parameters

Returns void

dispose

Parameters

Returns Promise<void>

emit

Type Parameters

Parameters

Returns boolean

eventNames

Type Parameters

Returns U[]

getBlock

Parameters

Returns number

getMaxListeners

Returns number

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

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

loadPlayer

Parameters

Returns void

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

`Static`blockset

`Static`bounds

`Static`commandInterpreterClass

`Static`commands

`Static`defaultMaxListeners

`Static`environment

`Static`standardBounds

`Static`template

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

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

`Static`getCommandClassFromName

`Static`loadIntoUniverse

`Static`sendBlockset

`Static`teleportPlayer