ProjectMetadata
class
ProjectMetadata
extends
ObjectMetaField
ReturnType
typeof
createProjectMetadata
Constructors
constructor
Parameters
-
project : Project
ObjectMetaField< ReturnType>.constructor
Properties
description
public
description
:
string
=
''
ObjectMetaField.description
initial
readonly
public
initial
:
ValueOf
preview
:
ObjectMetaField
fps
:
NumberMetaField
=
...
resolutionScale
:
EnumMetaField
number
=
...
=
...
rendering
:
ObjectMetaField
colorSpace
:
EnumMetaField
CanvasColorSpace
=
...
exporter
:
ExporterMetaField
=
...
fps
:
NumberMetaField
=
...
resolutionScale
:
EnumMetaField
number
=
...
=
...
shared
:
ObjectMetaField
audioOffset
:
NumberMetaField
=
...
background
:
ColorMetaField
=
...
range
:
RangeMetaField
=
...
size
:
Vector2MetaField
=
...
=
...
version
:
MetaField
unknown
number
=
...
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
:
ObjectMetaField
fps
:
NumberMetaField
=
...
resolutionScale
:
EnumMetaField
number
=
...
=
...
ObjectMetaField.preview
rendering
rendering
:
ObjectMetaField
colorSpace
:
EnumMetaField
CanvasColorSpace
=
...
exporter
:
ExporterMetaField
=
...
fps
:
NumberMetaField
=
...
resolutionScale
:
EnumMetaField
number
=
...
=
...
ObjectMetaField.rendering
shared
shared
:
ObjectMetaField
audioOffset
:
NumberMetaField
=
...
background
:
ColorMetaField
=
...
range
:
RangeMetaField
=
...
size
:
Vector2MetaField
=
...
=
...
ObjectMetaField.shared
spacing
public
spacing
:
boolean
=
false
ObjectMetaField.spacing
type
readonly
public
type
:
ObjectConstructor
=
Object
ObjectMetaField.type
version
version
:
MetaField
unknown
number
=
...
ObjectMetaField.version
Events
onChanged
public
get
onChanged
():
SubscribableValueEvent
TValue
Triggered when the data of this field changes.
Inherited from
ObjectMetaField.onChanged
onDisabled
public
get
onDisabled
():
SubscribableValueEvent
boolean
Triggered when the field becomes disabled or enabled.
Inherited from
ObjectMetaField.onDisabled
onFieldsChanged
public
get
onFieldsChanged
():
SubscribableValueEvent
MetaField
unknown
unknown
[]
Triggered when the nested fields change.
Inherited from
ObjectMetaField.onFieldsChanged
Methods
clone
public
clone
():
ProjectMetadata
ObjectMetaField.clone
describe
public
describe
description
:
string
:
ProjectMetadata
Set the description of this field.
Parameters
-
description : stringThe description.
ObjectMetaField.describe
disable
public
disable
value
:
boolean
=
true
:
ProjectMetadata
Disable or enable the field in the editor.
Parameters
-
value : boolean = trueWhether the field should be disabled.
ObjectMetaField.disable
get
public
get
():
ValueOf
preview
:
ObjectMetaField
fps
:
NumberMetaField
=
...
resolutionScale
:
EnumMetaField
number
=
...
=
...
rendering
:
ObjectMetaField
colorSpace
:
EnumMetaField
CanvasColorSpace
=
...
exporter
:
ExporterMetaField
=
...
fps
:
NumberMetaField
=
...
resolutionScale
:
EnumMetaField
number
=
...
=
...
shared
:
ObjectMetaField
audioOffset
:
NumberMetaField
=
...
background
:
ColorMetaField
=
...
range
:
RangeMetaField
=
...
size
:
Vector2MetaField
=
...
=
...
version
:
MetaField
unknown
number
=
...
Get the current value.
Inherited from
ObjectMetaField.get
getFullPreviewSettings
public
getFullPreviewSettings
():
audioOffset
:
number
background
:
null
Color
fps
:
number
range
:
number
number
resolutionScale
:
number
size
:
Vector2
getFullRenderingSettings
public
getFullRenderingSettings
():
audioOffset
:
number
background
:
null
Color
colorSpace
:
CanvasColorSpace
exporter
:
name
:
string
options
:
unknown
fps
:
number
range
:
number
number
resolutionScale
:
number
size
:
Vector2
parse
public
parse
value
:
ValueOf
preview
:
ObjectMetaField
fps
:
NumberMetaField
=
...
resolutionScale
:
EnumMetaField
number
=
...
=
...
rendering
:
ObjectMetaField
colorSpace
:
EnumMetaField
CanvasColorSpace
=
...
exporter
:
ExporterMetaField
=
...
fps
:
NumberMetaField
=
...
resolutionScale
:
EnumMetaField
number
=
...
=
...
shared
:
ObjectMetaField
audioOffset
:
NumberMetaField
=
...
background
:
ColorMetaField
=
...
range
:
RangeMetaField
=
...
size
:
Vector2MetaField
=
...
=
...
version
:
MetaField
unknown
number
=
...
:
ValueOf
preview
:
ObjectMetaField
fps
:
NumberMetaField
=
...
resolutionScale
:
EnumMetaField
number
=
...
=
...
rendering
:
ObjectMetaField
colorSpace
:
EnumMetaField
CanvasColorSpace
=
...
exporter
:
ExporterMetaField
=
...
fps
:
NumberMetaField
=
...
resolutionScale
:
EnumMetaField
number
=
...
=
...
shared
:
ObjectMetaField
audioOffset
:
NumberMetaField
=
...
background
:
ColorMetaField
=
...
range
:
RangeMetaField
=
...
size
:
Vector2MetaField
=
...
=
...
version
:
MetaField
unknown
number
=
...
Convert a serialized value into a runtime type.
Parameters
-
value : ValueOf preview : ObjectMetaField fps : NumberMetaField = ... resolutionScale : EnumMetaField number = ... = ... rendering : ObjectMetaField colorSpace : EnumMetaField CanvasColorSpace = ... exporter : ExporterMetaField = ... fps : NumberMetaField = ... resolutionScale : EnumMetaField number = ... = ... shared : ObjectMetaField audioOffset : NumberMetaField = ... background : ColorMetaField = ... range : RangeMetaField = ... size : Vector2MetaField = ... = ... version : MetaField unknown number = ...The serialized value.
ObjectMetaField.parse
serialize
public
serialize
():
ValueOf
preview
:
ObjectMetaField
fps
:
NumberMetaField
=
...
resolutionScale
:
EnumMetaField
number
=
...
=
...
rendering
:
ObjectMetaField
colorSpace
:
EnumMetaField
CanvasColorSpace
=
...
exporter
:
ExporterMetaField
=
...
fps
:
NumberMetaField
=
...
resolutionScale
:
EnumMetaField
number
=
...
=
...
shared
:
ObjectMetaField
audioOffset
:
NumberMetaField
=
...
background
:
ColorMetaField
=
...
range
:
RangeMetaField
=
...
size
:
Vector2MetaField
=
...
=
...
version
:
MetaField
unknown
number
=
...
ObjectMetaField.serialize
set
public
set
value
:
Partial
ValueOf
preview
:
ObjectMetaField
fps
:
NumberMetaField
=
...
resolutionScale
:
EnumMetaField
number
=
...
=
...
rendering
:
ObjectMetaField
colorSpace
:
EnumMetaField
CanvasColorSpace
=
...
exporter
:
ExporterMetaField
=
...
fps
:
NumberMetaField
=
...
resolutionScale
:
EnumMetaField
number
=
...
=
...
shared
:
ObjectMetaField
audioOffset
:
NumberMetaField
=
...
background
:
ColorMetaField
=
...
range
:
RangeMetaField
=
...
size
:
Vector2MetaField
=
...
=
...
version
:
MetaField
unknown
number
=
...
:
void
Parameters
-
value : Partial ValueOf preview : ObjectMetaField fps : NumberMetaField = ... resolutionScale : EnumMetaField number = ... = ... rendering : ObjectMetaField colorSpace : EnumMetaField CanvasColorSpace = ... exporter : ExporterMetaField = ... fps : NumberMetaField = ... resolutionScale : EnumMetaField number = ... = ... shared : ObjectMetaField audioOffset : NumberMetaField = ... background : ColorMetaField = ... range : RangeMetaField = ... size : Vector2MetaField = ... = ... version : MetaField unknown number = ...
ObjectMetaField.set
space
public
space
value
:
boolean
=
true
:
ProjectMetadata
Add or remove spacing at the beginning of this field.
Parameters
-
value : boolean = trueWhether to include the spacing.
ObjectMetaField.space