Skip to main content

ColorMetaField

class ColorMetaField extends MetaFieldPossibleColornullColornull

Represents a color stored in a meta file.

Constructors​

constructor​

public new ColorMetaFieldname: stringinitial: nullColor: ColorMetaField

Parameters

  • name: string

    The name of this field displayed in the editor.

  • initial: nullColor

    The initial value of this field.

Inherited from MetaField.constructor

Properties​

description​

public description: string = ''
Inherited from MetaField.description

initial​

readonly public initial: nullColor

The initial value of this field.

Inherited from MetaField.initial

name​

readonly public name: string

The name of this field displayed in the editor.

Inherited from MetaField.name

spacing​

public spacing: boolean = false
Inherited from MetaField.spacing

type​

readonly public type: symbol = Color.symbol

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

Events​

onChanged​

public get onChanged(): SubscribableValueEventTValue

Triggered when the data of this field changes.

Inherited from MetaField.onChanged

onDisabled​

public get onDisabled(): SubscribableValueEventboolean

Triggered when the field becomes disabled or enabled.

Inherited from MetaField.onDisabled

Methods​

clone​

public clone(): ColorMetaField

Create a clone of this field.

Inherited from MetaField.clone

describe​

public describedescription: string: ColorMetaField

Set the description of this field.

Parameters

Inherited from MetaField.describe

disable​

public disablevalue: boolean = true: ColorMetaField

Disable or enable the field in the editor.

Parameters

  • value: boolean = true

    Whether the field should be disabled.

Inherited from MetaField.disable

get​

public get(): nullColor

Get the current value.

Inherited from MetaField.get

parse​

public override parsevalue: nullPossibleColor: nullColor

Convert a serialized value into a runtime type.

Parameters

Overwrites MetaField.parse

serialize​

public override serialize(): nullPossibleColor

Serialize the value of this field.

Overwrites MetaField.serialize

set​

public setvalue: nullPossibleColor: void

Set the current value.

Parameters

Inherited from MetaField.set

space​

public spacevalue: boolean = true: ColorMetaField

Add or remove spacing at the beginning of this field.

Parameters

  • value: boolean = true

    Whether to include the spacing.

Inherited from MetaField.space