[This is preliminary documentation and is subject to change.]

A standard build task that provides data upon completion.

Namespace: org.critterai.nmbuild
Assembly: cai-nmbuild (in cai-nmbuild.dll) Version: 0.4.0.0 (0.4.0.0)

Syntax

         
 C#  Visual Basic  Visual C++ 
public abstract class BuildTask<T> : IBuildTask, 
	IPriorityItem
Public MustInherit Class BuildTask(Of T) _
	Implements IBuildTask, IPriorityItem
generic<typename T>
public ref class BuildTask abstract : IBuildTask, 
	IPriorityItem

Type Parameters

T
The type of data provided upon completion.

Members

            
 All Members  Constructors   Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
BuildTask<(Of <(<'T>)>)>(Int32)
Constructor.
Abort(String)
Requests an abort of the task.
AddMessage(String)
Adds a message to the message queue.
AddMessages(array<String>[]()[][])
Appends an array of messages to the message queue.
FinalizeTask()()()()
Finalize the task.
GetResult(T%)
Gets the result of the completed task.
IsFinished
The task is in a finished state.
IsThreadSafe
If true, the task can be safely run on a separate thread from the object(s) monitoring its state.
LocalUpdate()()()()
Performs a work increment.
Messages
Messages available after the task is finished.
Priority
The priority of the item.
Result
The data produced by the task.
Run()()()()
Runs the task through to a finished state.
TaskState
The current state of the task.

Remarks

The task is single use. The task is constructed, run, then its data and messages retrieved.

Inheritance Hierarchy

System..::..Object
  org.critterai.nmbuild..::..BuildTask<(Of <(<'T>)>)>
    org.critterai.nmbuild..::..NMGenTask
    org.critterai.nmbuild..::..TileBuildTask

See Also