EnumMetaField

class EnumMetaFieldT extends MetaFieldT

Type Parameters

• T

Constructors​

constructor​

public override new EnumMetaFieldname: stringoptions: MetaOptionT[]initial: T = ...: EnumMetaFieldT

Parameters

• name: string
• options: MetaOptionT[]
• initial: T = ...

Properties​

description​

public description: string = ''

initial​

readonly public initial: T

The initial value of this field.

name​

readonly public name: string

The name of this field displayed in the editor.

options​

readonly public options: MetaOptionT[]

spacing​

public spacing: boolean = false

type​

readonly public type: symbol = EnumMetaField.symbol

The type of this field used by the editor to display the correct input.

symbol​

static readonly public symbol: typeof symbol = ...

Methods​

clone​

public clone(): this

Create a clone of this field.

describe​

public describedescription: string: this

Set the description of this field.

Parameters

• description: string

  The description.

disable​

public disablevalue: boolean = true: this

Disable or enable the field in the editor.

Parameters

• value: boolean = true

  Whether the field should be disabled.

get​

public get(): T

Get the current value.

getOption​

public getOptionvalue: T: MetaOptionT

Parameters

• value: T

parse​

public override parsevalue: T: T

Convert a serialized value into a runtime type.

Parameters

• value: T

  The serialized value.

serialize​

public serialize(): T

Serialize the value of this field.

set​

public override setvalue: T: void

Set the current value.

Parameters

• value: T

  The new value.

space​

public spacevalue: boolean = true: this

Add or remove spacing at the beginning of this field.

Parameters

• value: boolean = true

  Whether to include the spacing.

Events​

onChanged​

public get onChanged(): SubscribableValueEventTValue

Triggered when the data of this field changes.

onDisabled​

public get onDisabled(): SubscribableValueEventboolean

Triggered when the field becomes disabled or enabled.