Class AssetManager

Base class for all script-accessible Lens Studio objects.

Hierarchy (View Summary)

ScriptObject
- AssetManager

Constructors

`Protected`constructor

new AssetManager(): AssetManager
Snap Hidden
Returns AssetManager
Overrides ScriptObject.constructor

Properties

`Readonly`assets

assets: Editor.Assets.Asset[]

`Readonly`assetsDirectory

assetsDirectory: Path

`Readonly`cacheDirectory

cacheDirectory: Path

Methods

createNativeAsset

createNativeAsset(
    assetType: string,
    baseName: string,
    relativeDestinationDir: SourcePath,
): Editor.Assets.Asset
Parameters
- assetType: string
- baseName: string
- relativeDestinationDir: SourcePath
Returns Editor.Assets.Asset

createPackage

createPackage(
    requestedAssets: Editor.Model.AssetImportMetadata[],
    relativeDestinationDir: SourcePath,
    packageName: string,
    packageOption: PackageOption,
): Editor.Model.AssetImportMetadata
Parameters
- requestedAssets: Editor.Model.AssetImportMetadata[]
- relativeDestinationDir: SourcePath
- packageName: string
- packageOption: PackageOption
Returns Editor.Model.AssetImportMetadata

exportAssets

exportAssets(
requestedAssets: Editor.Model.AssetImportMetadata[],
absoluteDestination: Path,
): Editor.Model.AssetImportMetadata[]
Parameters
- requestedAssets: Editor.Model.AssetImportMetadata[]
- absoluteDestination: Path
Returns Editor.Model.AssetImportMetadata[]

exportSceneObjects

exportSceneObjects(
topLevelSceneObjects: SceneObject[],
absoluteDestination: Path,
): Editor.Model.AssetImportMetadata[]
Parameters
- topLevelSceneObjects: SceneObject[]
- absoluteDestination: Path
Returns Editor.Model.AssetImportMetadata[]

findCopyOrImport

findCopyOrImport(
    absoluteSourcePath: Path,
    relativeDestinationDir?: SourcePath,
    options?: any,
): Editor.Model.AssetImportMetadata
Parameters
- absoluteSourcePath: Path
- OptionalrelativeDestinationDir: SourcePath
- Optionaloptions: any
Returns Editor.Model.AssetImportMetadata

findImportedCopy

findImportedCopy(
    absoluteSourcePath: Path,
    relativeDestinationDir?: SourcePath,
    options?: any,
): Editor.Model.AssetImportMetadata
Find a copy, if it exists, of a file.
Parameters
- absoluteSourcePath: Path
- OptionalrelativeDestinationDir: SourcePath
- Optionaloptions: any
Returns Editor.Model.AssetImportMetadata

getFileMeta

getFileMeta(relativeFilePath: SourcePath): Editor.Model.AssetImportMetadata
Parameters
- relativeFilePath: SourcePath
Returns Editor.Model.AssetImportMetadata

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from ScriptObject.getTypeName

importExternalFile

importExternalFile(
    absoluteSourcePath: Path,
    relativeDestinationDir?: SourcePath,
    resultType?: ResultType,
    importSettings?: ImportSettings,
): ImportResult
Parameters
- absoluteSourcePath: Path
- OptionalrelativeDestinationDir: SourcePath
- OptionalresultType: ResultType
- OptionalimportSettings: ImportSettings
Returns ImportResult

importExternalFileAsync

importExternalFileAsync(
    absoluteSourcePath: Path,
    relativeDestinationDir?: SourcePath,
    resultType?: ResultType,
    importSettings?: ImportSettings,
): Promise<ImportResult>
Parameters
- absoluteSourcePath: Path
- OptionalrelativeDestinationDir: SourcePath
- OptionalresultType: ResultType
- OptionalimportSettings: ImportSettings
Returns Promise<ImportResult>

instantiate

instantiate(
assets: Editor.Assets.Asset[],
params?: InstantiationParams,
): Promise<Prefabable[]>
Parameters
- assets: Editor.Assets.Asset[]
- Optionalparams: InstantiationParams
Returns Promise<Prefabable[]>

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from ScriptObject.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from ScriptObject.isSame

move

move(
fileMeta: Editor.Model.AssetImportMetadata,
relativeDestinationDir: SourcePath,
): void
Parameters
- fileMeta: Editor.Model.AssetImportMetadata
- relativeDestinationDir: SourcePath
Returns void

remove

remove(relativeFilePath: SourcePath): void
Parameters
- relativeFilePath: SourcePath
Returns void

rename

rename(fileMeta: Editor.Model.AssetImportMetadata, newName: string): void
Parameters
- fileMeta: Editor.Model.AssetImportMetadata
- newName: string
Returns void

saveAsPrefab

saveAsPrefab(
    sceneObject: SceneObject,
    relativeDestinationDir: SourcePath,
    preferredName?: string,
): ObjectPrefab
Parameters
- sceneObject: SceneObject
- relativeDestinationDir: SourcePath
- OptionalpreferredName: string
Returns ObjectPrefab

saveAsPrefabVariant

saveAsPrefabVariant(
    sceneObject: SceneObject,
    relativeDestinationDir: SourcePath,
    preferredName?: string,
): ObjectPrefab
Parameters
- sceneObject: SceneObject
- relativeDestinationDir: SourcePath
- OptionalpreferredName: string
Returns ObjectPrefab

unpack

unpack(
nativePackageRoot: Editor.Model.AssetImportMetadata,
): Promise<ImportResult>
Parameters
- nativePackageRoot: Editor.Model.AssetImportMetadata
Returns Promise<ImportResult>