Skip to main content

ProjectMetadata

class ProjectMetadata extends ObjectMetaFieldReturnTypetypeof createProjectMetadata

Represents an object with nested meta-fields.

Constructors​

constructor​

public override new ProjectMetadataproject: Project: ProjectMetadata

Parameters

Overwrites ObjectMetaField< ReturnType<typeof createProjectMetadata> >.constructor

Properties​

description​

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

initial​

readonly public initial: ValueOf

The initial value of this field.

Inherited from ObjectMetaField.initial

name​

readonly public name: string

The name of this field displayed in the editor.

Inherited from ObjectMetaField.name

preview​

preview: ObjectMetaFieldfps: NumberMetaField = ...resolutionScale: EnumMetaFieldnumber = ... = ...
Inherited from ObjectMetaField.preview

rendering​

rendering: ObjectMetaFieldcolorSpace: EnumMetaFieldCanvasColorSpace = ...exporter: ExporterMetaField = ...fps: NumberMetaField = ...resolutionScale: EnumMetaFieldnumber = ... = ...
Inherited from ObjectMetaField.rendering

shared​

shared: ObjectMetaFieldaudioOffset: NumberMetaField = ...background: ColorMetaField = ...range: RangeMetaField = ...size: Vector2MetaField = ... = ...
Inherited from ObjectMetaField.shared

spacing​

public spacing: boolean = false
Inherited from ObjectMetaField.spacing

type​

readonly public type: ObjectConstructor = Object

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

Inherited from ObjectMetaField.type

version​

version: MetaFieldunknownnumber = ...
Inherited from ObjectMetaField.version

Methods​

clone​

public clone(): this

Create a clone of this field.

Inherited from ObjectMetaField.clone

describe​

public describedescription: string: this

Set the description of this field.

Parameters

Inherited from ObjectMetaField.describe

disable​

public disablevalue: boolean = true: this

Disable or enable the field in the editor.

Parameters

  • value: boolean = true

    Whether the field should be disabled.

Inherited from ObjectMetaField.disable

get​

public get(): ValueOf

Get the current value.

Inherited from ObjectMetaField.get

getFullPreviewSettings​

public getFullPreviewSettings(): audioOffset: numberbackground: nullColorfps: numberrange: numbernumberresolutionScale: numbersize: Vector2

getFullRenderingSettings​

public getFullRenderingSettings(): audioOffset: numberbackground: nullColorcolorSpace: CanvasColorSpaceexporter: name: stringoptions: unknownfps: numberrange: numbernumberresolutionScale: numbersize: Vector2

parse​

public parsevalue: ValueOf: ValueOf

Convert a serialized value into a runtime type.

Parameters

  • value: ValueOf

    The serialized value.

Inherited from ObjectMetaField.parse

serialize​

public serialize(): ValueOfpreview: ObjectMetaFieldfps: NumberMetaField = ...resolutionScale: EnumMetaFieldnumber = ... = ...rendering: ObjectMetaFieldcolorSpace: EnumMetaFieldCanvasColorSpace = ...exporter: ExporterMetaField = ...fps: NumberMetaField = ...resolutionScale: EnumMetaFieldnumber = ... = ...shared: ObjectMetaFieldaudioOffset: NumberMetaField = ...background: ColorMetaField = ...range: RangeMetaField = ...size: Vector2MetaField = ... = ...version: MetaFieldunknownnumber = ...

Serialize the value of this field.

Inherited from ObjectMetaField.serialize

set​

public setvalue: PartialValueOfpreview: ObjectMetaFieldfps: NumberMetaField = ...resolutionScale: EnumMetaFieldnumber = ... = ...rendering: ObjectMetaFieldcolorSpace: EnumMetaFieldCanvasColorSpace = ...exporter: ExporterMetaField = ...fps: NumberMetaField = ...resolutionScale: EnumMetaFieldnumber = ... = ...shared: ObjectMetaFieldaudioOffset: NumberMetaField = ...background: ColorMetaField = ...range: RangeMetaField = ...size: Vector2MetaField = ... = ...version: MetaFieldunknownnumber = ...: void

Set the current value.

Parameters

  • value: PartialValueOfpreview: ObjectMetaFieldfps: NumberMetaField = ...resolutionScale: EnumMetaFieldnumber = ... = ...rendering: ObjectMetaFieldcolorSpace: EnumMetaFieldCanvasColorSpace = ...exporter: ExporterMetaField = ...fps: NumberMetaField = ...resolutionScale: EnumMetaFieldnumber = ... = ...shared: ObjectMetaFieldaudioOffset: NumberMetaField = ...background: ColorMetaField = ...range: RangeMetaField = ...size: Vector2MetaField = ... = ...version: MetaFieldunknownnumber = ...

    The new value.

Inherited from ObjectMetaField.set

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.

Inherited from ObjectMetaField.space

Events​

onChanged​

public get onChanged(): SubscribableValueEventTValue

Triggered when the data of this field changes.

Inherited from ObjectMetaField.onChanged

onDisabled​

public get onDisabled(): SubscribableValueEventboolean

Triggered when the field becomes disabled or enabled.

Inherited from ObjectMetaField.onDisabled

onFieldsChanged​

public get onFieldsChanged(): SubscribableValueEventMetaFieldunknownunknown[]

Triggered when the nested fields change.

Inherited from ObjectMetaField.onFieldsChanged