Class PositionEnum

Hierarchy (View Summary)

ValidEnum
- PositionEnum

Index

Constructors

Properties

optional result default enums identifier name symbol type

Methods

validate extract

Constructors

constructor

new PositionEnum(result: null | Vector3f): PositionEnum
Parameters
- result: null | Vector3f
Returns PositionEnum
Overrides ValidEnum.constructor
- Defined in packages/core/src/commands/enums/valid/position.ts:21

Properties

optional

optional: boolean = true

Whether the enum value is optional.

`Readonly`result

result: null | Vector3f

`Static` `Readonly`default

default: Enum = ...

`Static` `Readonly`enums

enums: Map<string, Enum> = ...

`Static` `Readonly`identifier

identifier: string

`Static` `Readonly`name

name: "position"

The type of the enum.

`Static` `Readonly`symbol

symbol: number = ...

The symbol of the enum.

`Static` `Readonly`type

type: 16 = 0x10

The type of the enum.

Methods

validate

validate(error?: boolean): boolean
Checks if the enum value is applicable.
Parameters
- Optionalerror: boolean
  Whether to throw an error if the enum value is not applicable.
Returns boolean
Returns true if the enum value is applicable, or false otherwise.
Overrides ValidEnum.validate
- Defined in packages/core/src/commands/enums/valid/position.ts:26

`Static`extract

extract(pointer: CommandArgumentPointer): null | PositionEnum
Reads the next value from the pointer.
Parameters
- pointer: CommandArgumentPointer
  The pointer to read from.
Returns null | PositionEnum
Overrides ValidEnum.extract
- Defined in packages/core/src/commands/enums/valid/position.ts:36