NavMesh
NavMesh Options
string
Name of the data file to store this navmesh in (relative to engine executable).
The method to use to handle water surfaces.
float
Length/width of a voxel.
float
Height of a voxel.
float
The horizontal size of tiles.
float
Height of an actor.
float
Maximum climbing height of an actor.
float
Radius of an actor.
float
Maximum walkable slope in degrees.
bool
Is this NavMesh for smaller-than-usual characters?
bool
Is this NavMesh for regular-sized characters?
bool
Is this NavMesh for larger-than-usual characters?
NavMesh Annotations
string
Name of the SimGroup to store cover points in.
bool
Add cover points everywhere, not just on corners?
float
Distance to the side of each cover point that peeking happens.
NavMesh Rendering
bool
Display this NavMesh even outside the editor.
NavMesh Advanced Options
int
Size of the non-walkable border around the navigation mesh (in voxels).
float
Sets the sampling distance to use when generating the detail mesh.
float
The maximum distance the detail mesh surface should deviate from heightfield data.
int
The maximum allowed length for contour edges along the border of the mesh.
float
The maximum distance a simplfied contour's border edges should deviate from the original raw contour.
int
The minimum number of cells allowed to form isolated island areas.
int
Any regions with a span count smaller than this value will, if possible, be merged with larger regions.
int
The maximum number of polygons allowed in a tile.
Public Static Attributes
bool
Disables rendering of all instances of this type.
bool
Disables selection of all instances of this type.
Public Functions
bool
build(bool background, bool save)
Create a Recast nav mesh.
void
Build tiles of this mesh where there are unsynchronised links.
void
buildTiles(Box3F box)
Rebuild the tiles overlapped by the input box.
void
Cancel the current NavMesh build.
bool
Create cover points for this NavMesh.
void
Remove all cover points for this NavMesh.
void
deleteLink(uint id)
Delete a given off-mesh link.
void
Deletes all off-mesh links on this NavMesh.
int
getLink(Point3F pos)
Get the off-mesh link closest to a given world point.
int
Return the number of links this mesh has.
Point3F
getLinkEnd(uint id)
Get the ending point of an off-mesh link.
int
getLinkFlags(uint id)
Get the flags set for a particular off-mesh link.
Point3F
getLinkStart(uint id)
Get the starting point of an off-mesh link.
void
setLinkFlags(uint id, uint flags)
Set the flags of a particular off-mesh link.
Detailed Description
UNDOCUMENTED!
NavMesh Options
string fileName
Name of the data file to store this navmesh in (relative to engine executable).
NavMeshWaterMethod waterMethod
The method to use to handle water surfaces.
float cellSize
Length/width of a voxel.
float cellHeight
Height of a voxel.
float tileSize
The horizontal size of tiles.
float actorHeight
Height of an actor.
float actorClimb
Maximum climbing height of an actor.
float actorRadius
Radius of an actor.
float walkableSlope
Maximum walkable slope in degrees.
bool smallCharacters
Is this NavMesh for smaller-than-usual characters?
bool regularCharacters
Is this NavMesh for regular-sized characters?
bool largeCharacters
Is this NavMesh for larger-than-usual characters?
bool vehicles
Is this NavMesh for characters driving vehicles?
NavMesh Annotations
string coverGroup
Name of the SimGroup to store cover points in.
bool innerCover
Add cover points everywhere, not just on corners?
float coverDist
Distance from the edge of the NavMesh to search for cover.
float peekDist
Distance to the side of each cover point that peeking happens.
NavMesh Rendering
bool alwaysRender
Display this NavMesh even outside the editor.
NavMesh Advanced Options
int borderSize
Size of the non-walkable border around the navigation mesh (in voxels).
float detailSampleDist
Sets the sampling distance to use when generating the detail mesh.
float detailSampleError
The maximum distance the detail mesh surface should deviate from heightfield data.
int maxEdgeLen
The maximum allowed length for contour edges along the border of the mesh.
float simplificationError
The maximum distance a simplfied contour's border edges should deviate from the original raw contour.
int minRegionArea
The minimum number of cells allowed to form isolated island areas.
int mergeRegionArea
Any regions with a span count smaller than this value will, if possible, be merged with larger regions.
int maxPolysPerTile
The maximum number of polygons allowed in a tile.
Public Static Attributes
bool isRenderable
Disables rendering of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
Public Functions
addLink(Point3F from, Point3F to, uint flags)
Add a link to this NavMesh between two points.
build(bool background, bool save)
Create a Recast nav mesh.
buildLinks()
Build tiles of this mesh where there are unsynchronised links.
buildTiles(Box3F box)
Rebuild the tiles overlapped by the input box.
cancelBuild()
Cancel the current NavMesh build.
createCoverPoints()
Create cover points for this NavMesh.
deleteCoverPoints()
Remove all cover points for this NavMesh.
deleteLink(uint id)
Delete a given off-mesh link.
deleteLinks()
Deletes all off-mesh links on this NavMesh.
getLink(Point3F pos)
Get the off-mesh link closest to a given world point.
getLinkCount()
Return the number of links this mesh has.
getLinkEnd(uint id)
Get the ending point of an off-mesh link.
getLinkFlags(uint id)
Get the flags set for a particular off-mesh link.
getLinkStart(uint id)
Get the starting point of an off-mesh link.
load()
Load this NavMesh from its file.
save()
Save this NavMesh to its file.
setLinkFlags(uint id, uint flags)
Set the flags of a particular off-mesh link.