Class BaseLevelCommandInterpreter

As an instance, I am initialized with a BaseLevel. I act on the level via commands provided by the BasePlayer or by other sources, such as ChangeRecord loading. I may be used interactively by a player. This causes the level to block writes to avoid potential conflict with input intended as responses to my interactive questions.

Hierarchy

TypedEmitter
- BaseLevelCommandInterpreter

Constructors

constructor

new BaseLevelCommandInterpreter(
level: BaseLevel<any>,
): BaseLevelCommandInterpreter
Create an instance of a BaseLevelCommandInterpreter for a BaseLevel.
Parameters
- level: BaseLevel<any>
 The BaseLevel.
Returns BaseLevelCommandInterpreter
Overrides TypedEmitter.constructor
- Defined in class/level/BaseLevelCommandInterpreter.mjs:28

Properties

currentCommand

currentCommand: any

currentCommandActionBytes

currentCommandActionBytes: any[] | number[]

currentCommandLayoutIndex

currentCommandLayoutIndex: number

level

level: BaseLevel<any>

`Static`defaultMaxListeners

defaultMaxListeners: number

`Static`parsingErrors

parsingErrors: {
    invalidBlockId: number;
    invalidPosition: number;
    positionOutBounds: number;
} = ...

Todo

Yet to be documented.

Methods

addListener

addListener(
 event: U,
 listener: {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => void;
 }[U],
): this
Type Parameters
- U extends "parsingError" | "typeQuestion" | "commandExecuted"
Parameters
- event: U
- listener: {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => 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

commitAction

commitAction(player?: BasePlayer): void
Executes the currentCommand with currentCommandActionBytes to my level.
Parameters
- player: BasePlayer = null
Returns void
- Defined in class/level/BaseLevelCommandInterpreter.mjs:183

dispose

dispose(): void
Perform cleanup by removing all listeners that I created.

Returns void
- Defined in class/level/BaseLevelCommandInterpreter.mjs:205

emit

emit(
 event: U,
 ...args: Parameters<
 {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => void;
 }[U],
 >,
): boolean
Type Parameters
- U extends "parsingError" | "typeQuestion" | "commandExecuted"
Parameters
- event: U
- ...args: Parameters<
 {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => 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 "parsingError" | "typeQuestion" | "commandExecuted"
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

inferCurrentCommand

inferCurrentCommand(
providedData?: { block: number; position: Vector3 },
player?: BasePlayer,
): any
Parameters
- OptionalprovidedData: { block: number; position: Vector3 } = null
- player: BasePlayer = null
Returns any
Todo
Yet to be documented.
- Defined in class/level/BaseLevelCommandInterpreter.mjs:68

interpretCommand

interpretCommand(
    command?: string,
    player?: BasePlayer,
    actionBytes?: number[],
): boolean
Interprets the given command as a string. My level will be used to get the names of available commands. I will attempt to fill out required data, but if I am missing data, I will start interactive questions for the missing bytes. When this happens, my level will be set as blocking, and block placements will be used for answering the questions.
Parameters
- command: string = "cuboid 1"
- player: BasePlayer = null
- OptionalactionBytes: number[] = []
  Default is []
Returns boolean
- Defined in class/level/BaseLevelCommandInterpreter.mjs:40

listenerCount

listenerCount(type: "parsingError" | "typeQuestion" | "commandExecuted"): number
Parameters
- type: "parsingError" | "typeQuestion" | "commandExecuted"
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,
): {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => void;
}[U][]
Type Parameters
- U extends "parsingError" | "typeQuestion" | "commandExecuted"
Parameters
- type: U
Returns {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => 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: {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => void;
 }[U],
): this
Type Parameters
- U extends "parsingError" | "typeQuestion" | "commandExecuted"
Parameters
- event: U
- listener: {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => 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: {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => void;
 }[U],
): this
Type Parameters
- U extends "parsingError" | "typeQuestion" | "commandExecuted"
Parameters
- event: U
- listener: {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => 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: {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => void;
 }[U],
): this
Type Parameters
- U extends "parsingError" | "typeQuestion" | "commandExecuted"
Parameters
- event: U
- listener: {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => 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: {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => void;
 }[U],
): this
Type Parameters
- U extends "parsingError" | "typeQuestion" | "commandExecuted"
Parameters
- event: U
- listener: {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => 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: {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => void;
 }[U],
): this
Type Parameters
- U extends "parsingError" | "typeQuestion" | "commandExecuted"
Parameters
- event: U
- listener: {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => 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

processCommandArguments

processCommandArguments(splitCommand: string[], player: BasePlayer): void
Parameters
- splitCommand: string[]
- player: BasePlayer
Returns void
Todo
Yet to be documented.
- Defined in class/level/BaseLevelCommandInterpreter.mjs:110

rawListeners

rawListeners(
 type: U,
): {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => void;
}[U][]
Type Parameters
- U extends "parsingError" | "typeQuestion" | "commandExecuted"
Parameters
- type: U
Returns {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => 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?: "parsingError" | "typeQuestion" | "commandExecuted",
): this
Parameters
- Optionalevent: "parsingError" | "typeQuestion" | "commandExecuted"
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: {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => void;
 }[U],
): this
Type Parameters
- U extends "parsingError" | "typeQuestion" | "commandExecuted"
Parameters
- event: U
- listener: {
 commandExecuted: (commandName: string, actionBytes: number[]) => void;
 parsingError: (player: BasePlayer, errorType: number) => void;
 typeQuestion: (typeQuestion: TypeQuestion) => 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

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

`Static`validateByte

validateByte(number: number): boolean
Checks if the given number is a byte. Returns false if it isn't. Otherwise true.
Parameters
- number: number
Returns boolean
- Defined in class/level/BaseLevelCommandInterpreter.mjs:213

Class BaseLevelCommandInterpreter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BaseLevelCommandInterpreter

Properties

currentCommand

currentCommandActionBytes

currentCommandLayoutIndex

level

StaticdefaultMaxListeners

StaticparsingErrors

Todo

Methods

addListener

Type Parameters

Parameters

Returns this

commitAction

Parameters

Returns void

dispose

Returns void

emit

Type Parameters

Parameters

Returns boolean

eventNames

Type Parameters

Returns U[]

getMaxListeners

Returns number

inferCurrentCommand

Parameters

Returns any

Todo

interpretCommand

Parameters

Returns boolean

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns { commandExecuted: (commandName: string, actionBytes: number[]) => void; parsingError: (player: BasePlayer, errorType: number) => void; typeQuestion: (typeQuestion: TypeQuestion) => 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

processCommandArguments

Parameters

Returns void

Todo

rawListeners

Type Parameters

Parameters

Returns { commandExecuted: (commandName: string, actionBytes: number[]) => void; parsingError: (player: BasePlayer, errorType: number) => void; typeQuestion: (typeQuestion: TypeQuestion) => void;}[U][]

removeAllListeners

`Static`defaultMaxListeners

`Static`parsingErrors

Returns {
commandExecuted: (commandName: string, actionBytes: number[]) => void;
parsingError: (player: BasePlayer, errorType: number) => void;
typeQuestion: (typeQuestion: TypeQuestion) => void;
}[U][]

Returns {
commandExecuted: (commandName: string, actionBytes: number[]) => void;
parsingError: (player: BasePlayer, errorType: number) => void;
typeQuestion: (typeQuestion: TypeQuestion) => void;
}[U][]

`Static`validateByte