navmesh Class Reference

#include <LUA_API_Navmesh.h>

Public Member Functions
void navmesh	addEntity ()
	Add Entity Navmesh. More...
void navmesh	removeEntity ()
	Remove Entity Navmesh. More...
void navmesh	addDCC ()
	Add Dynamic character controller. More...
void navmesh	setDestination ()
	Set Destination. More...
void navmesh	getDestination ()
	Get Destination. More...
void navmesh	getRandomPosition () void navmesh.setAgentHeight()
	Get random position. More...
void navmesh	setAgentWidth ()
	Set Agent Width. More...
void navmesh	setAgentMaxSpeed ()
	Set Agent maximum speed. More...
void navmesh	setAgentMaxAccel ()
	Set Agent maximum accelleration. More...
void navmesh	setAgentColQueryRange ()
	Set Agent collision query range. More...
void navmesh	setAgentPathOptRange ()
	Set Agent path optimum range. More...
void navmesh	setAgentControlled ()
	Set Agent controlled. More...
void navmesh	showAgentDebug ()
	Show agent debug. More...
void navmesh	isDestinationReached ()
	Is destination reached. More...
void navmesh	getAgentSpeed ()
	Get Agent Speed. More...
void navmesh	getAgentMaxSpeed ()
	Get Agent Maximum Speed. More...
void navmesh	getAgentVelocity ()
	Get Agent Velocity. More...
void navmesh	stopAgent ()
	Stop Agent. More...

Detailed Description

This area covers navmesh functions. Set or get various navmesh propertie.
Use as navmesh.function()
These functions are designed to create / destroy and control navmesh agents. Attach a sceneEntity or SCC/DCC to
an agent to let them follow a path through complex obstacles.
For more information on how these functions can be used please visit the User Manual - http://www.aurasoft-skyline.co.uk

Member Function Documentation

void navmesh navmesh::addDCC

(

)

Add Dynamic character controller.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    navmesh.addDCC();
end

void navmesh navmesh::addEntity

(

)

Add Entity Navmesh.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    navmesh.addEntity( );
end

void navmesh navmesh::getAgentMaxSpeed

(

)

Get Agent Maximum Speed.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    navmesh.getAgentMaxSpeed();
end

void navmesh navmesh::getAgentSpeed

(

)

Get Agent Speed.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    navmesh.getAgentSpeed();
end

void navmesh navmesh::getAgentVelocity

(

)

Get Agent Velocity.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    navmesh.getAgentVelocity();
end

void navmesh navmesh::getDestination

(

)

Get Destination.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end

void navmesh navmesh::getRandomPosition

(

)

Get random position.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    navmesh.getRandomPosition()
end

Set Agent Height

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    navmesh.setAgentHeight();
end

void navmesh navmesh::isDestinationReached

(

)

Is destination reached.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    navmesh.isDestinationReached();
end

void navmesh navmesh::removeEntity

(

)

Remove Entity Navmesh.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    navmesh.removeEntity();
end

void navmesh navmesh::setAgentColQueryRange

(

)

Set Agent collision query range.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    navmesh.setAgentColQueryRange();
end

void navmesh navmesh::setAgentControlled

(

)

Set Agent controlled.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    navmesh.setAgentControlled();
end

void navmesh navmesh::setAgentMaxAccel

(

)

Set Agent maximum accelleration.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    navmesh.setAgentMaxAccel();
end

void navmesh navmesh::setAgentMaxSpeed

(

)

Set Agent maximum speed.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    navmesh.setAgentMaxSpeed();
end

void navmesh navmesh::setAgentPathOptRange

(

)

Set Agent path optimum range.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    navmesh.setAgentPathOptRange();
end

void navmesh navmesh::setAgentWidth

(

)

Set Agent Width.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    navmesh.setAgentWidth();
end

void navmesh navmesh::setDestination

(

)

Set Destination.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    navmesh.setDestination();
end

void navmesh navmesh::showAgentDebug

(

)

Show agent debug.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    navmesh.showAgentDebug();
end

void navmesh navmesh::stopAgent

(

)

Stop Agent.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    navmesh.stopAgent();
end

---

The documentation for this class was generated from the following file:

• LUA_API_Navmesh.h