Skip to main content

ExporterMetaField

class ExporterMetaField extends MetaFieldname: stringoptions: unknown

Represents the exporter configuration.

Constructors​

constructor​

public override new ExporterMetaFieldname: stringproject: Projectcurrent: number = 0: ExporterMetaField

Parameters

Overwrites MetaField.constructor

Properties​

description​

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

exporters​

readonly public exporters: ExporterClass[]

initial​

readonly public initial: name: stringoptions: unknown

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: ObjectConstructor = Object

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

onFieldsChanged​

public get onFieldsChanged(): SubscribableValueEventMetaFieldanyany[]

Triggered when the nested fields change.

Accessors​

options​

public get options(): undefinedMetaFieldanyany

Methods​

clone​

public override clone(): ExporterMetaField

Create a clone of this field.

Overwrites MetaField.clone

describe​

public describedescription: string: ExporterMetaField

Set the description of this field.

Parameters

Inherited from MetaField.describe

disable​

public disablevalue: boolean = true: ExporterMetaField

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(): name: stringoptions: unknown

Get the current value.

Inherited from MetaField.get

parse​

public parsevalue: name: stringoptions: unknown: name: stringoptions: unknown

Convert a serialized value into a runtime type.

Parameters

Inherited from MetaField.parse

serialize​

public override serialize(): name: stringoptions: any

Serialize the value of this field.

Overwrites MetaField.serialize

set​

public override setvalue: name: stringoptions: any: void

Set the current value.

Parameters

Overwrites MetaField.set

space​

public spacevalue: boolean = true: ExporterMetaField

Add or remove spacing at the beginning of this field.

Parameters

  • value: boolean = true

    Whether to include the spacing.

Inherited from MetaField.space