editor.Assets.Importers.IAssetImporter Interface Reference

Interface for file format importers. More...

Inheritance diagram for editor.Assets.Importers.IAssetImporter:

Public Member Functions
bool	CanHandle (string filePath)
IReadOnlyList< IAssetImporter >	GetAllSettingsImporters ()
	Returns all importers whose settings should be shown in the UI when this importer's files are selected.
IReadOnlyList< ImporterSetting >	GetSettings ()
	Returns an ordered list of setting descriptors for the auto-generated settings UI.
Task< IReadOnlyList< string > >	Import (string realSourcePath, ImportContext ctx, Action< string > log, Action< double >? progress=null)

Properties
IReadOnlyList< string >	SupportedExtensions [get]
string	DisplayName [get]
	Human-readable name shown in the settings card header.
LucideIconKind	Icon [get]
	Lucide icon shown in the settings card header.
BaseAsset	PrimaryOutputType [get]
	Primary asset type this importer produces.
IReadOnlyList< BaseAsset >	OutputTypes [get]
	All asset types this importer may produce.

Detailed Description

Interface for file format importers.

Member Function Documentation

GetAllSettingsImporters()

IReadOnlyList< IAssetImporter > editor.Assets.Importers.IAssetImporter.GetAllSettingsImporters ( )

inline

Returns all importers whose settings should be shown in the UI when this importer's files are selected.

Composite importers return themselves plus any sub-importers they delegate to

Implemented in editor.Assets.Importers.GltfImporter, and editor.Assets.Importers.PsdImporter.

GetSettings()

IReadOnlyList< ImporterSetting > editor.Assets.Importers.IAssetImporter.GetSettings

(

)

Returns an ordered list of setting descriptors for the auto-generated settings UI.

Adding a descriptor here automatically adds a row to the import window

Implemented in editor.Assets.Importers.AudioBankImporter, editor.Assets.Importers.AudioStringImporter, editor.Assets.Importers.FontImporter, editor.Assets.Importers.GltfImporter, editor.Assets.Importers.PsdImporter, editor.Assets.Importers.TextureImporter, editor.Assets.Importers.UIImageImporter, and editor.Assets.Importers.VoxImporter.

Property Documentation

DisplayName

string editor.Assets.Importers.IAssetImporter.DisplayName

get

Human-readable name shown in the settings card header.

Implemented in editor.Assets.Importers.AudioBankImporter, editor.Assets.Importers.AudioStringImporter, editor.Assets.Importers.FontImporter, editor.Assets.Importers.GltfImporter, editor.Assets.Importers.PsdImporter, editor.Assets.Importers.TextureImporter, editor.Assets.Importers.UIImageImporter, and editor.Assets.Importers.VoxImporter.

Icon

LucideIconKind editor.Assets.Importers.IAssetImporter.Icon

get

Lucide icon shown in the settings card header.

Implemented in editor.Assets.Importers.AudioBankImporter, editor.Assets.Importers.AudioStringImporter, editor.Assets.Importers.FontImporter, editor.Assets.Importers.GltfImporter, editor.Assets.Importers.PsdImporter, editor.Assets.Importers.TextureImporter, editor.Assets.Importers.UIImageImporter, and editor.Assets.Importers.VoxImporter.

OutputTypes

IReadOnlyList<BaseAsset> editor.Assets.Importers.IAssetImporter.OutputTypes

get

All asset types this importer may produce.

Implemented in editor.Assets.Importers.AudioStringImporter, editor.Assets.Importers.GltfImporter, and editor.Assets.Importers.VoxImporter.

PrimaryOutputType

BaseAsset editor.Assets.Importers.IAssetImporter.PrimaryOutputType

get

Primary asset type this importer produces.

Implemented in editor.Assets.Importers.AudioBankImporter, editor.Assets.Importers.AudioStringImporter, editor.Assets.Importers.FontImporter, editor.Assets.Importers.GltfImporter, editor.Assets.Importers.PsdImporter, editor.Assets.Importers.TextureImporter, editor.Assets.Importers.UIImageImporter, and editor.Assets.Importers.VoxImporter.

---

The documentation for this interface was generated from the following file:

• editor/Assets/Importers/IAssetImporter.cs