Class Importer

Module responsible for importing various asset types and converting them to types usable by the engine.

Index

Constructors

Methods

import importAll importAllAsync importAsync peek supportsFileType

Constructors

constructor

new Importer(): Importer
Returns Importer

Methods

`Static`import

import(inputFilePath, importOptions?, uuid?): Resource
Imports a resource at the specified location, and returns the loaded data. If file contains more than one resource only the primary resource is imported (for example an FBX a mesh would be imported, but animations ignored).
Parameters
- inputFilePath: FilePath
  Pathname of the input file.
- OptionalimportOptions: Const<ImportOptions>
  (optional) Options for controlling the import. Caller must ensure import options actually match the type of the importer used for the file type.
- Optionaluuid: UUID
  Specific UUID to assign to the resource. If not specified a randomly generated UUID will be assigned.
Returns Resource
Imported resource.

Note
Thread safe.

`Static`importAll

importAll(inputFilePath, importOptions?): MultiResource
Imports a resource at the specified location, and returns the loaded data. This method returns all imported resources, which is relevant for files that can contain multiple resources (for example an FBX which may contain both a mesh and animations).
Parameters
- inputFilePath: FilePath
  Pathname of the input file.
- OptionalimportOptions: Const<ImportOptions>
  (optional) Options for controlling the import. Caller must ensure import options actually match the type of the importer used for the file type.
Returns MultiResource
A list of all imported resources. The primary resource is always the first returned resource.

Note
Thread safe.

`Static`importAllAsync

importAllAsync(inputFilePath, importOptions?): AsyncOp<MultiResource, void>
Same as ImportAll(), except it imports a resource without blocking the main thread. The returned AsyncOp will contain a list of the imported resources, after the import ends.
Parameters
- inputFilePath: FilePath
- OptionalimportOptions: Const<ImportOptions>
Returns AsyncOp<MultiResource, void>

`Static`importAsync

importAsync(inputFilePath, importOptions?, uuid?): AsyncOp<ResourceHandle<Resource>, void>
Same as Import(), except it imports a resource without blocking the main thread. The resulting resource will be placed in the returned AsyncOp object when the import ends.
Parameters
- inputFilePath: FilePath
- OptionalimportOptions: Const<ImportOptions>
- Optionaluuid: UUID
Returns AsyncOp<ResourceHandle<Resource>, void>

`Static`peek

peek(inputFilePath): ImportFileInformation
Peek into a file to gather information about it.
Parameters
- inputFilePath: FilePath
Returns ImportFileInformation
A object with the best Import Options for that given file and also a cache of the information that has been read.

`Static`supportsFileType

supportsFileType(extension): boolean
Checks if we can import a file with the specified extension.
Parameters
- extension: string
  The extension without the leading dot.
Returns boolean