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

Creates a new task.

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 static TileBuildTask Create(
	int tx,
	int tz,
	PolyMeshData polyData,
	PolyMeshDetailData detailData,
	ConnectionSet conns,
	bool bvTreeEnabled,
	bool isThreadSafe,
	int priority
)
Public Shared Function Create ( _
	tx As Integer, _
	tz As Integer, _
	polyData As PolyMeshData, _
	detailData As PolyMeshDetailData, _
	conns As ConnectionSet, _
	bvTreeEnabled As Boolean, _
	isThreadSafe As Boolean, _
	priority As Integer _
) As TileBuildTask
public:
static TileBuildTask^ Create(
	int tx, 
	int tz, 
	PolyMeshData^ polyData, 
	PolyMeshDetailData^ detailData, 
	ConnectionSet^ conns, 
	bool bvTreeEnabled, 
	bool isThreadSafe, 
	int priority
)

Parameters

tx
Int32
The x-index of the tile within the tile grid. (x, z)
tz
Int32
The z-index of the tile within the tile grid. (x, z)
polyData
PolyMeshData
The polygon mesh data.
detailData
PolyMeshDetailData
The detail mesh data. (Optional)
conns
ConnectionSet
The off-mesh connection set.
bvTreeEnabled
Boolean
True if bounding volumes should be generated.
isThreadSafe
Boolean
True if the task is safe to run on its own thread.
priority
Int32
The task priority.

Return Value

A new task, or null on error.

Remarks

The task should only be marked as thread-safe if the data parameters are treated as immutable while the task is running.

Creation will fail on null parameters, invalid tile indices, and an empty polygon mesh.

See Also