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

A task used to manage the build of an IncrementalBuilder object.

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 sealed class NMGenTask : BuildTask<NMGenAssets>
Public NotInheritable Class NMGenTask _
	Inherits BuildTask(Of NMGenAssets)
public ref class NMGenTask sealed : public BuildTask<NMGenAssets>

Members

         
 All Members  Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
Create(IncrementalBuilder, Int32)
Creates a new task.
GetResult(NMGenAssets%)
Gets the result of the completed task.
(Overrides BuildTask<(Of <(<'T>)>)>..::..GetResult(T%).)
IsThreadSafe
If true, the task is safe to run on its own thread.
(Overrides BuildTask<(Of <(<'T>)>)>..::..IsThreadSafe.)
LocalUpdate()()()()
Performs a work increment.
(Overrides BuildTask<(Of <(<'T>)>)>..::..LocalUpdate()()()().)
TileX
The x-index of the tile within the tile grid. (x, z)
TileZ
The z-index of the tile within the tile grid. (x, z)

Remarks

The primary purpose of this class is to run the builder on a background thread. It handles aborts and exception handling, which are not possible if the builder is run directly on a thread.

Inheritance Hierarchy

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

See Also