NavPath

consoledoc.h

More...

NavPath

Point3F

World location this path starts at.

Point3F

World location this path should end at.

string

Name of the NavMesh object this path travels within.

Path containing waypoints for this NavPath to visit.

bool

Does this path loop?

bool

Plan this path over multiple updates instead of all at once.

int

Maximum iterations of path planning this path does per tick.

bool

If set, this path will automatically replan when its navigation mesh changes.

Flags

bool

Allow the path to use dry land.

bool

Allow the path to use jump links.

bool

Allow the path to use drop links.

bool

Allow the path to move in water.

bool

Allow the path to jump ledges.

bool

Allow the path to use climb links.

bool

Allow the path to use teleporters.

NavPath Render

bool

Render this NavPath even when not selected.

bool

Render this NavPath through other objects.

bool

Render the closed list of this NavPath's search.

Public Static Attributes

bool

Disables rendering of all instances of this type.

bool

Disables selection of all instances of this type.

Public Functions

int
getFlags(int idx)

Get a specified node along the path.

float

Get the length of this path.

Point3F
getNode(int idx)

Get a specified node along the path.

void
onNavMeshUpdate(string data)

Callback when this path's NavMesh is loaded or rebuilt.

void
onNavMeshUpdateBox(string data)

Callback when a particular area in this path's NavMesh is rebuilt.

bool
plan()

Find a path using the already-specified path properties.

int
size()

Return the number of nodes in this path.

Detailed Description

UNDOCUMENTED!

NavPath

Point3F from 

World location this path starts at.

Point3F to 

World location this path should end at.

string mesh 

Name of the NavMesh object this path travels within.

Path waypoints 

Path containing waypoints for this NavPath to visit.

bool isLooping 

Does this path loop?

bool isSliced 

Plan this path over multiple updates instead of all at once.

int maxIterations 

Maximum iterations of path planning this path does per tick.

bool autoUpdate 

If set, this path will automatically replan when its navigation mesh changes.

Flags

bool allowWalk 

Allow the path to use dry land.

bool allowJump 

Allow the path to use jump links.

bool allowDrop 

Allow the path to use drop links.

bool allowSwim 

Allow the path to move in water.

bool allowLedge 

Allow the path to jump ledges.

bool allowClimb 

Allow the path to use climb links.

bool allowTeleport 

Allow the path to use teleporters.

NavPath Render

bool alwaysRender 

Render this NavPath even when not selected.

bool xray 

Render this NavPath through other objects.

bool renderSearch 

Render the closed list of this NavPath's search.

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

getFlags(int idx)

Get a specified node along the path.

getLength()

Get the length of this path.

getNode(int idx)

Get a specified node along the path.

onNavMeshUpdate(string data)

Callback when this path's NavMesh is loaded or rebuilt.

onNavMeshUpdateBox(string data)

Callback when a particular area in this path's NavMesh is rebuilt.

plan()

Find a path using the already-specified path properties.

size()

Return the number of nodes in this path.