25 Metadata Type Object

The Metadata type object stores data relevant to an asset.

All members in Metadata are OPTIONAL and if they are not specified, the default value will be used. Modules and extension specifications can define additional members in type Metadata beyond those specified in this section. It is RECOMMENDED that modules make use of the attachment and propertiesmembers rather than introducing new members in the Metadata type.

Metadata type is define as

interface Metadata {
	id: string,
	name: string,
	description: string,
	preview: string,
	creators: string[],
	attachment: ArtifactAttachment
	properties: ArtifactProperties
	// ...
}

where

• id MUST be of type string representing the path or asset ID of the artifact. Its default value is the content string of the artifact. It is RECOMMENDED that all artifacts loaded in the scene have distinct id values.
• name MUST be of type string and is the display name of the artifact. Its default value is "Artifact".
• description MUST be of type string and is the display description of the artifact. Its default value is "", i.e., an empty string.
• preview MUST be of type string containing the URL to the preview image file, and it is RECOMMENDED that the preview image file be of type PNG.
• creators MUST be an array of string representing the creators of the artifact.
• attachment MUST be of type ArtifactAttachment, representing any associated files relevant to this artifact. The attachment member is mainly used by modules and extension specifications.
• properties MUST be of type ArtifactProperties. It stores data that modifies or enhances the artifact's behavior in the scene. The properties member is mainly used by modules and extension specifications.