PLUGIN SDK / Jobs and tasks / TaskProgress

TaskProgress

A running editor task (worker thread).

Kindclass

NamespaceKroys.Plugins

Members3

SourceOptions.cs

DECLARATION

Declaration

Namespace Kroys.Plugins, assembly KroysPlugins.Sdk.dll.

public sealed unsafe class TaskProgress

REFERENCE

Properties

#public bool IsCancelled { get; }

The user cancelled the task (throw OperationCanceledException or return).

property

Methods

#public void Report(float fraction, string stage)

Progress 0..1 and the stage text in the Tasks panel.

method

#public void Fail(string message)

Fails the task with a message.

method

public bool IsCancelled { get; }
public void Report(float fraction, string stage)
public void Fail(string message)

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.