Class ResourceMetaData

Class containing meta-information describing a resource.

Hierarchy (View Summary)

ResourceMetaData
- MaterialResourceMetaData
- TextureResourceMetaData

Index

Constructors

Accessors

affixResourceFlags affixResourceUUID description displayName importOptions importSourceData pathInSourceAsset polyverseAssetID polyverseData polyverseLibraryID sourcePath

Methods

getAffixResourceDataNumberValue getAffixResourceDataStringValue setAffixResourceDataNumberValue setAffixResourceDataStringValue

Constructors

`Protected`constructor

new ResourceMetaData(isInternalConstructor?: boolean): ResourceMetaData
Parameters
- OptionalisInternalConstructor: boolean
Returns ResourceMetaData

Overrides FrameworkObject.constructor

Accessors

affixResourceFlags

get affixResourceFlags(): EnumValue<AffixResourceFlags>

The flags for the relation to the dependent.

Returns EnumValue<AffixResourceFlags>
set affixResourceFlags(value: EnumValue<AffixResourceFlags>): void
Parameters
- value: EnumValue<AffixResourceFlags>
Returns void

affixResourceUUID

get affixResourceUUID(): UUID

The UUID of the resource that this instance depends on.

Returns UUID

Note
The resource may be unavailable in the library.
set affixResourceUUID(value: UUID): void
Parameters
- value: UUID
Returns void

description

get description(): string

The description of the Resource.

Returns string
set description(value: string): void
Parameters
- value: string
Returns void

displayName

get displayName(): string

The name of the Resource to be displayed.

Returns string
set displayName(value: string): void
Parameters
- value: string
Returns void

importOptions

get importOptions(): ImportOptions

The import options.

Returns ImportOptions
set importOptions(value: ImportOptions): void
Parameters
- value: ImportOptions
Returns void

importSourceData

get importSourceData(): SourceAssetData

The source asset data, used to regenerate the imported asset.

Returns SourceAssetData

pathInSourceAsset

get pathInSourceAsset(): FilePath

The path in the source asset when it was imported into the library.

Returns FilePath

polyverseAssetID

get polyverseAssetID(): string

The Polyverse Library ID, if imported via Polyverse.

Returns string

polyverseData

get polyverseData(): JsonObject

Polyverse specific data, set if imported via Polyverse.

Returns JsonObject

polyverseLibraryID

get polyverseLibraryID(): string

The Polyverse Library ID, if imported via Polyverse.

Returns string

sourcePath

get sourcePath(): FilePath

The absolute file path where the file was imported from the users file system.

Returns FilePath
set sourcePath(value: FilePath): void
Parameters
- value: FilePath
Returns void

Methods

getAffixResourceDataNumberValue

getAffixResourceDataNumberValue(key: string): number
Gets the affix resource data for the specified key.
Parameters
- key: string
Returns number

getAffixResourceDataStringValue

getAffixResourceDataStringValue(key: string): string
Gets the affix resource data for the specified key.
Parameters
- key: string
Returns string

setAffixResourceDataNumberValue

setAffixResourceDataNumberValue(key: string, value: number): void
Sets the affaffixrix resource data key to the specified
Parameters
- key: string
- value: number
Returns void

setAffixResourceDataStringValue

setAffixResourceDataStringValue(key: string, value: string): void
Sets the affix resource data key to the specified string
Parameters
- key: string
- value: string
Returns void