BuildProgress Class

Represents the amount of progress a build task is at.

Inheritance Hierarchy

SystemObject
UMod.BuildPipelineBuildProgress

Namespace: UMod.BuildPipeline
Assembly: UMod-BuildPipeline (in UMod-BuildPipeline.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

[SerializableAttribute]
public sealed class BuildProgress

The BuildProgress type exposes the following members.

Constructors

	Name	Description
	BuildProgress	Initializes a new instance of the BuildProgress class

Properties

	Name	Description
	CurrentPercentage	Get the current percentage value for the build.
	CurrentProgress	Get the current progress value for the build. The valud is normalized between 0-1 where 0 represents no progress and 1 represents a completed build.
	CurrentTask	Get the task that is currently being performed by the build engine.
	IsCancelled	Returns true if the user has cancelled the export via the progress dialog window. This value will remain true after the initial cancel.
	Title

Methods

	Name	Description
	CloseProgressWindow
	DisplayProgressWindow	Force the progress dialog to be shown using the current progress values. The progress window will be automatically displayed as a result of calling SetCurrentProgress(Single), SetCurrentProgress(Int32, Int32) or SetCurrentTask(String). Use CloseProgressWindow to hide the progress window if required.
	NextTask
	Reset	Reset the build progress.
	SetCurrentProgress(Single)	Set the current progress value for the current progress task. The progress window will be automatically shown as a result of calling this method.
	SetCurrentProgress(Int32, Int32)	Set the current progress values for a task that has a number of steps. This method will automatically calculate the progress value using the provided information. The progress window will be automatically shown as a result of calling this method.
	SetCurrentTask	Set the info of the current progress action. The progress window will be automatically shown as a result of calling this method.
	SetMaxTasks

Fields

	Name	Description
	progressPercentageMacro