Class ResourceEntryMetaData

The ResourceEntryMetaData is an Editor only class that provides meta-data information for a Resource as stored in the ProjectLibrary.

Hierarchy

FrameworkObject
- ResourceEntryMetaData

Index

Constructors

Accessors

cachedImportOptions cachedImportSourceData cachedImportSourcePath cachedResourceMetaData deploymentPlatforms editorData flags importerType libraryMetaData packageResourceMetaData resourceType tags type uuid

Constructors

`Protected`constructor

new ResourceEntryMetaData(isInternalConstructor?): ResourceEntryMetaData
Parameters
- OptionalisInternalConstructor: boolean
Returns ResourceEntryMetaData
Inherited from ResourceEntryMetaDataGenerated.constructor

Accessors

cachedImportOptions

get cachedImportOptions(): Immutable<ImportOptions>
The cached resource ImportOptions used for importing the in-engine resource from a sourcefile.

Returns Immutable<ImportOptions>

cachedImportSourceData

get cachedImportSourceData(): Immutable<SourceAssetData>
Gets information about the Source asset from this Resource.

Returns Immutable<SourceAssetData>
Note
The returned object is part of ResourceMetaData. To make changes to the ResourceMetaData load the resource and edit the meta data directly. Call ProjectLibrary.save to persist any changes. Otherwise the changes will be lost if the resource is loaded into memory, discarded or saved.

cachedImportSourcePath

get cachedImportSourcePath(): FilePath
Get and Set the source path of the asset this entry was imported from, if any.

Returns FilePath
Note
The returned object is part of ResourceMetaData. To make changes to the ResourceMetaData load the resource and edit the meta data directly. Call ProjectLibrary.save to persist any changes. Otherwise the changes will be lost if the resource is loaded into memory, discarded or saved.

cachedResourceMetaData

get cachedResourceMetaData(): Immutable<ResourceMetaData>
The cached resource meta data.

Returns Immutable<ResourceMetaData>
Note
The returned object should be considered immutable. To make changes to the ResourceMetaData load the resource and edit the meta data directly. Call ProjectLibrary.save to persist any changes. Otherwise the changes will be lost if the resource is loaded into memory, discarded or saved.

deploymentPlatforms

get deploymentPlatforms(): EnumValueTyped<PlatformFlag, number>
Determines the platforms that will include the resource, even when not referenced directly through the main scene.

Returns EnumValueTyped<PlatformFlag, number>

editorData

get editorData(): any
Non-specific data assigned to the resource, available in editor only.

Returns any

flags

get flags(): EnumValue<ProjectLibraryEntryMetaDataFlags, number>
Returns the resource flags for the project resource.

Returns EnumValue<ProjectLibraryEntryMetaDataFlags, number>

importerType

get importerType(): Type
Returns the resource type that determine which importer will be used for importing the asset at sourcePath/

Returns Type

libraryMetaData

get libraryMetaData(): ProjectLibraryMetaData
Returns ProjectLibraryMetaData
Inherited from ResourceEntryMetaDataGenerated.libraryMetaData
set libraryMetaData(value): void
Parameters
- value: ProjectLibraryMetaData
Returns void
Inherited from ResourceEntryMetaDataGenerated.libraryMetaData

packageResourceMetaData

get packageResourceMetaData(): PackageResourceMetaData
Returns PackageResourceMetaData
Inherited from ResourceEntryMetaDataGenerated.packageResourceMetaData
set packageResourceMetaData(value): void
Parameters
- value: PackageResourceMetaData
Returns void
Inherited from ResourceEntryMetaDataGenerated.packageResourceMetaData

resourceType

get resourceType(): EnumValue<ResourceType, number>
Type of the resource referenced by this entry.

Returns EnumValue<ResourceType, number>

tags

get tags(): Immutable<LibraryEntryTag>[]
Gets the Resource Tags present from this Resource.

Returns Immutable<LibraryEntryTag>[]

type

get type(): Type
Type information of the resource referenced by this entry.

Returns Type

uuid

get uuid(): UUID
Unique identifier of the resource.

Returns UUID