PLUGIN SDK / Jobs and tasks / FileJob

FileJob

An import or export job (worker thread).

Kindclass

NamespaceKroys.Plugins

Members6

SourceOptions.cs

DECLARATION

Declaration

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

Declaration

public sealed unsafe class FileJob

REFERENCE

Members

Properties

#public string SourcePath { get; }

The file to convert.

property

#public string OutputPath { get; }

Write the result here.

property

#public bool IsCancelled { get; }

The user cancelled the job.

property

Methods

#public void SetProgress(float fraction)

Progress 0..1.

method

#public void Warning(string message)

A warning in the task's diagnostics.

method

#public void Error(string message)

Fails the job with a message.

method

Signatures

public string SourcePath { get; }
public string OutputPath { get; }
public bool IsCancelled { get; }
public void SetProgress(float fraction)
public void Warning(string message)
public void Error(string message)

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