Class TargetEnum

Hierarchy (View Summary)

ValidEnum
- TargetEnum

Index

Constructors

Properties

optional result default enums identifier symbol type

Methods

validate extract

Constructors

constructor

new TargetEnum(result: null | Entity[]): TargetEnum
Parameters
- result: null | Entity[]
Returns TargetEnum
Overrides ValidEnum.constructor
- Defined in packages/core/src/commands/enums/valid/target.ts:24

Properties

optional

optional: boolean = true

Whether the enum value is optional.

`Readonly`result

result: null | Entity[]

The result of the enum.

`Static` `Readonly`default

default: Enum = ...

`Static` `Readonly`enums

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

`Static` `Readonly`identifier

identifier: "target"

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
- error: boolean = false
  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/target.ts:29

`Static`extract

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