Class ImportFileEntry

File import entry.

System.Object
ImportFileEntry
AssetImportEntry
FolderImportEntry
Namespace: FlaxEditor.Content.Import
Assembly: FlaxEngine.CSharp.dll
Syntax
public class ImportFileEntry : Object, IFileEntryAction

Constructors

ImportFileEntry(ref Request)

Initializes a new instance of the ImportFileEntry class.

Declaration
public ImportFileEntry(ref Request request)
Parameters
FlaxEditor.Content.Import.Request request

The import request.

Fields

FileTypes

The file types registered for importing. Key is a file extension (without a leading dot). Allows to plug custom importing options gather for different input file types.

Declaration
public static readonly Dictionary<string, ImportFileEntryHandler> FileTypes
Field Value
System.Collections.Generic.Dictionary<System.String, ImportFileEntryHandler>

Properties

HasSettings

Gets a value indicating whether this entry has settings to modify.

Declaration
public virtual bool HasSettings { get; }
Property Value
System.Boolean

ResultUrl

Declaration
public string ResultUrl { get; }
Property Value
System.String

Settings

Gets or sets the settings object to modify.

Declaration
public virtual object Settings { get; }
Property Value
System.Object

SourceUrl

Declaration
public string SourceUrl { get; }
Property Value
System.String

Methods

CreateEntry(ref Request)

Creates the entry.

Declaration
public static ImportFileEntry CreateEntry(ref Request request)
Parameters
FlaxEditor.Content.Import.Request request

The import request.
Returns
ImportFileEntry

Created file entry.

Execute()

Declaration
public bool Execute()
Returns
System.Boolean

Import()

Performs file importing.

Declaration
public virtual bool Import()
Returns
System.Boolean

True if failed, otherwise false.

ModifyResultFilename(String)

Modifies the result URL filename (keeps destination folder and extension).

Declaration
public void ModifyResultFilename(string filename)
Parameters
System.String filename

The new filename.

TryOverrideSettings(Object)

Tries the override import settings.

Declaration
public virtual bool TryOverrideSettings(object settings)
Parameters
System.Object settings

The settings.
Returns
System.Boolean

True if settings override was successful and there is no need to edit them in dedicated dialog, otherwise false.

Extension Methods