Class AssetManager

Protectedconstructor

• new AssetManager(): AssetManager
  Snap Hidden

  Returns AssetManager

Readonlyassets

ReadonlyassetsDirectory

ReadonlycacheDirectory

createNativeAsset

• createNativeAsset(
      assetType: string,
      baseName: string,
      relativeDestinationDir: SourcePath,
  ): Editor.Assets.Asset

  Creates a new native asset of the specified type at the given destination path and returns it.

  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

  Packages a set of assets into a single package file at the specified destination and returns the resulting import metadata.

  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[]

  Exports the specified assets to an absolute destination path and returns metadata for the exported assets.

  Parameters

  • requestedAssets: Editor.Model.AssetImportMetadata[]
  • absoluteDestination: Path

  Returns Editor.Model.AssetImportMetadata[]

exportSceneObjects

• exportSceneObjects(
      topLevelSceneObjects: SceneObject[],
      absoluteDestination: Path,
  ): Editor.Model.AssetImportMetadata[]

  Exports top-level scene objects as assets to an absolute destination path and returns the resulting import metadata.

  Parameters

  • topLevelSceneObjects: SceneObject[]
  • absoluteDestination: Path

  Returns Editor.Model.AssetImportMetadata[]

findCopyOrImport

• findCopyOrImport(
      absoluteSourcePath: Path,
      relativeDestinationDir?: SourcePath,
      options?: any,
  ): Editor.Model.AssetImportMetadata

  Finds an existing imported copy of a file by its absolute source path, optionally scoped to a destination directory.

  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

  Returns import metadata for the asset at the given relative file path.

  Parameters

  • relativeFilePath: SourcePath

  Returns Editor.Model.AssetImportMetadata

importExternalFile

• importExternalFile(
      absoluteSourcePath: Path,
      relativeDestinationDir?: SourcePath,
      resultType?: ResultType,
      importSettings?: ImportSettings,
  ): ImportResult

  Imports an external file into the project synchronously and returns its import metadata.

  Parameters

  • absoluteSourcePath: Path
  • OptionalrelativeDestinationDir: SourcePath
  • OptionalresultType: ResultType
  • OptionalimportSettings: ImportSettings

  Returns ImportResult

importExternalFileAsync

• importExternalFileAsync(
      absoluteSourcePath: Path,
      relativeDestinationDir?: SourcePath,
      resultType?: ResultType,
      importSettings?: ImportSettings,
  ): Promise<ImportResult>

  Imports an external file into the project asynchronously and returns a promise resolving to its import metadata.

  Parameters

  • absoluteSourcePath: Path
  • OptionalrelativeDestinationDir: SourcePath
  • OptionalresultType: ResultType
  • OptionalimportSettings: ImportSettings

  Returns Promise<ImportResult>

instantiate

• instantiate(
      assets: Editor.Assets.Asset[],
      params?: InstantiationParams,
  ): Promise<Prefabable[]>

  Instantiates an asset into the scene and returns the resulting scene object.

  Parameters

  • assets: Editor.Assets.Asset[]
  • Optionalparams: InstantiationParams

  Returns Promise<Prefabable[]>

move

• move(
      fileMeta: Editor.Model.AssetImportMetadata,
      relativeDestinationDir: SourcePath,
  ): void

  Moves an asset to a new destination path within the project.

  Parameters

  • fileMeta: Editor.Model.AssetImportMetadata
  • relativeDestinationDir: SourcePath

  Returns void

remove

• remove(relativeFilePath: SourcePath): void

  Removes an asset from the project.

  Parameters

  • relativeFilePath: SourcePath

  Returns void

rename

• rename(fileMeta: Editor.Model.AssetImportMetadata, newName: string): void

  Renames an asset to the specified name.

  Parameters

  • fileMeta: Editor.Model.AssetImportMetadata
  • newName: string

  Returns void

saveAsPrefab

• saveAsPrefab(
      sceneObject: SceneObject,
      relativeDestinationDir: SourcePath,
      preferredName?: string,
  ): ObjectPrefab

  Saves a scene object as a new prefab asset at the specified destination.

  Parameters

  • sceneObject: SceneObject
  • relativeDestinationDir: SourcePath
  • OptionalpreferredName: string

  Returns ObjectPrefab

saveAsPrefabVariant

• saveAsPrefabVariant(
      sceneObject: SceneObject,
      relativeDestinationDir: SourcePath,
      preferredName?: string,
  ): ObjectPrefab

  Saves a scene object as a variant of an existing prefab asset.

  Parameters

  • sceneObject: SceneObject
  • relativeDestinationDir: SourcePath
  • OptionalpreferredName: string

  Returns ObjectPrefab

unpack

• unpack(
      nativePackageRoot: Editor.Model.AssetImportMetadata,
  ): Promise<ImportResult>

  Unpacks a packaged asset, extracting its contents into the project.

  Parameters

  • nativePackageRoot: Editor.Model.AssetImportMetadata

  Returns Promise<ImportResult>