Class ProgressReportingModule

Helper module for engine long-operations progress reporting in the editor (eg. files importing, static light baking, etc.).

Inheritance

System.Object

FlaxEditor.Modules.EditorModule

ProgressReportingModule

Namespace: FlaxEditor.Modules

Assembly: FlaxEngine.CSharp.dll

Syntax

public sealed class ProgressReportingModule : EditorModule

Fields

BakeEnvProbes

The environment probes baking progress handler.

Declaration

public readonly BakeEnvProbesProgress BakeEnvProbes

Field Value

BakeEnvProbesProgress

BakeLightmaps

The lightmaps baking progress handler.

Declaration

public readonly BakeLightmapsProgress BakeLightmaps

Field Value

BakeLightmapsProgress

BuildingGame

The game building progress handler.

Declaration

public readonly BuildingGameProgress BuildingGame

Field Value

BuildingGameProgress

CodeEditorOpen

The code editor async open progress handler.

Declaration

public readonly CodeEditorOpenProgress CodeEditorOpen

Field Value

CodeEditorOpenProgress

CompileScripts

The scripts compilation progress handler.

Declaration

public readonly CompileScriptsProgress CompileScripts

Field Value

CompileScriptsProgress

GenerateScriptsProjectFiles

The scripts project files generation progress handler.

Declaration

public readonly GenerateScriptsProjectFilesProgress GenerateScriptsProjectFiles

Field Value

GenerateScriptsProjectFilesProgress

ImportAssets

The assets importing progress handler.

Declaration

public readonly ImportAssetsProgress ImportAssets

Field Value

ImportAssetsProgress

LoadAssets

The assets loading progress handler.

Declaration

public readonly LoadAssetsProgress LoadAssets

Field Value

LoadAssetsProgress

NavMeshBuilding

The navigation mesh building progress handler.

Declaration

public readonly NavMeshBuildingProgress NavMeshBuilding

Field Value

NavMeshBuildingProgress

Properties

FirstActiveHandler

Gets the first active handler.

Declaration

public ProgressHandler FirstActiveHandler { get; }

Property Value

FlaxEditor.Progress.ProgressHandler

IsAnyActive

Gets a value indicating whether any progress handler is active.

Declaration

public bool IsAnyActive { get; }

Property Value

System.Boolean

Methods

RegisterHandler(ProgressHandler)

Registers the handler.

Declaration

public void RegisterHandler(ProgressHandler handler)

Parameters

FlaxEditor.Progress.ProgressHandler handler The handler.

UnregisterHandler(ProgressHandler)

Unregisters the handler.

Declaration

public void UnregisterHandler(ProgressHandler handler)

Parameters

FlaxEditor.Progress.ProgressHandler handler The handler.

Extension Methods

Extensions.ReflectiveCompare<T>(T, T)

Extensions.RawClone<T>(T)

See Also

FlaxEditor.Modules.EditorModule