Class ResourceImportData

Information about the import process that generated the in-engine resource.

Index

Constructors

Properties

_importOptions _path _pathInSourceAsset _sourceData _typeId

Accessors

importOptions path pathInSourceAsset sourceData typeId

Methods

assign clone isEqual isEqual

Constructors

constructor

new ResourceImportData(
    path?: FilePath,
    pathInSourceAsset?: FilePath,
    importOptions?: ImportOptions,
    sourceData?: SourceAssetData,
    typeId?: number,
): ResourceImportData
Parameters
- Optionalpath: FilePath
- OptionalpathInSourceAsset: FilePath
- OptionalimportOptions: ImportOptions
- OptionalsourceData: SourceAssetData
- OptionaltypeId: number
Returns ResourceImportData

Properties

`Protected`_importOptions

_importOptions: ImportOptions

`Protected`_path

_path: FilePath

`Protected`_pathInSourceAsset

_pathInSourceAsset: FilePath

`Protected`_sourceData

_sourceData: SourceAssetData

`Protected`_typeId

_typeId: number

Accessors

importOptions

get importOptions(): ImportOptions

The import options.

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

path

get path(): FilePath

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

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

pathInSourceAsset

get pathInSourceAsset(): FilePath

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

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

sourceData

get sourceData(): SourceAssetData

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

Returns SourceAssetData
set sourceData(value: SourceAssetData): void
Parameters
- value: SourceAssetData
Returns void

typeId

get typeId(): number

The RTTI type of the importer used.

Returns number
set typeId(value: number): void
Parameters
- value: number
Returns void

Methods

assign

assign(other: Immutable<ResourceImportData>): ResourceImportData
Copies all properties defined by the prototype of ResourceImportData from other to this instance.
Parameters
- other: Immutable<ResourceImportData>
Returns ResourceImportData

clone

clone(): ResourceImportData

Clones this instance and returns a new ResourceImportData with identical values.

Returns ResourceImportData

isEqual

isEqual(
this: Immutable<ResourceImportData>,
other: Immutable<ResourceImportData>,
): boolean
Determines if this ResourceImportData instance is equal to the other instance.
Parameters
- this: Immutable<ResourceImportData>
- other: Immutable<ResourceImportData>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<ResourceImportData>,
rhs: Immutable<ResourceImportData>,
): boolean
Determines if both ResourceImportData instances are equal.
Parameters
- lhs: Immutable<ResourceImportData>
- rhs: Immutable<ResourceImportData>
Returns boolean