This is a set of helper functions to handle Lua calls. More...

Classes
class	DtBhaveLuaScriptManager
class	DtLuaGlobalSingleton
class	DtLuaScriptController
	Controller for using Lua scripts. More...
class	DtLuaScriptDescriptor
class	DtLuaScriptManager
	Manager for using Lua scripts. More...
class	DtScriptPSR
	This stores any state associated with scripting. More...
class	DtScriptRepository
	Script Repository for storing Lua scripts. More...
Typedefs
typedef DtSimTask (	DtTaskCommandCreationFcn )(lua_State L, DtVrfObject vrfObject)
	typedefs for implementing VRF lua tasks/sets
typedef DtSetDataRequest (	DtSetCommandCreationFcn )(lua_State L, DtVrfObject vrfObject)
Functions
int	luaVRFBHAVETask_Template (lua_State *L, DtTaskCommandCreationFcn taskCreationFcn)
	Template functions used to factor out common code among all the VRF task and set lua commands.
int	luaVRFBHAVESet_Template (lua_State *L, DtSetCommandCreationFcn setCreationFcn)
int	luaVRFTask_BHAVEMoveToWaypoint (lua_State *L)
int	luaVRFTask_BHAVEMoveToLocation (lua_State *L)
int	luaVRFTask_BHAVEMoveAlongRoute (lua_State *L)
int	luaVRFTask_BHAVEPatrolRoute (lua_State *L)
int	luaVRFTask_BHAVEPatrolBetween (lua_State *L)
int	luaVRFTask_BHAVEFollow (lua_State *L)
int	luaVRFTask_BHAVEFlee (lua_State *L)
int	luaVRFTask_BHAVEHide (lua_State *L)
int	luaVRFTask_BHAVEWander (lua_State *L)
int	luaVRFSet_MovementMode (lua_State *L)
int	luaVRFSet_Script (lua_State *L)
DtSimTask *	createBHAVEMoveToWaypoint (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createBHAVEMoveToLocation (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createBHAVEMoveAlongRoute (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createBHAVEPatrolRoute (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createBHAVEPatrolBetween (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createBHAVEFollow (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createBHAVEFlee (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createBHAVEHide (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createBHAVEWander (lua_State L, DtVrfObject vrfObject)
DtSetDataRequest *	createMovementMode (lua_State L, DtVrfObject vrfObject)
DtSetDataRequest *	createScript (lua_State L, DtVrfObject vrfObject)
int	luaDrawLine (lua_State *l)
int	luaDrawPoint (lua_State *l)
int	luaCreateEntity (lua_State *l)
int	luaCreateAggregate (lua_State *l)
int	luaCreateWaypoint (lua_State *l)
int	luaCreateRoute (lua_State *l)
int	luaCreatePhaseLine (lua_State *l)
int	luaCreateControlArea (lua_State *l)
int	luaCreateObstacle (lua_State *l)
int	luaCreateDisagregateArea (lua_State *l)
int	luaRemoveEntity (lua_State *l)
int	luaRemoveObject (lua_State *l)
DT_DLL_vrfLua bool	DtLuaFunctionExists (lua_State luaState, const char functionName)
	Determine whether or not a function exists.
DT_DLL_vrfLua bool	DtLuaRun (lua_State luaState, const char functionName)
	Execute a lua function.
DT_DLL_vrfLua bool	DtLuaRun (lua_State luaState, const char func, const char *sig,...)
	Execite a lua function with arguments. Example: DtLuaRun("f", "dd>d", x, y, &z);.
DT_DLL_vrfLua int	DtLuaReport (lua_State *L, int status)
	Lua Debugging functions.
DT_DLL_vrfLua void	DtLuaStackDump (lua_State *state)
DT_DLL_vrfLua void	DtLuaPrintValue (lua_State *state, int index, DtOutputStream &stream)
DT_DLL_vrfLua void	DtLuaPrintTable (lua_State *state, int index, DtOutputStream &stream)
DT_DLL_vrfLua int	DtLuaErrorHandler (lua_State *L)
DT_DLL_vrfLua int	DtLuaAppendPath (lua_State L, const char path)
	Add a path into Lua for include files.
DT_DLL_vrfLua DtVrfObject *	DtLuaGetThisVRFObject (lua_State *l)
	returns the C++ equivalent of that VRF Object "this"
DT_DLL_vrfLua DtVrfObject *	DtLuaPopVRFObject (lua_State *l)
	If a Lua VRF Object is the first item in the stack, this returns the C++ equivalent of that VRF Object and removes out of the stack.
DT_DLL_vrfLua DtVrfObject *	DtLuaGetVRFObject (lua_State *l)
	If a Lua VRF Object is the first item in the stack, this returns the C++ equivalent of that VRF Object.
int	luaUtilGetVRFExerciseTime (lua_State *l)
	Global function used by some of these functions - This should really be in a class.
int	luaUtilGetVRFExerciseStartTime (lua_State *l)
int	luaVRFRadioSendTextMessage (lua_State *l)
int	luaGetVrfObjects (lua_State *l)
int	luaGetVrfObjectByName (lua_State *l)
int	luaGetVrfObjectByGlobalId (lua_State *l)
int	luaGetVisibleVrfObjectList (lua_State *l)
int	luaAddSubordinate (lua_State *l)
int	luaRemoveSubordinate (lua_State *l)
int	luaGetTerrainElevation (lua_State *l)
int	luaQueryLineOfSight (lua_State *l)
static void	setLocationRequestCallack (DtSimMessage msg, void usrData)
	static callback used for "set location request" radio message
static void	textRadioMessageCallback (DtSimMessage msg, void usrData)
	static callback used for "text report" radio message
int	parseTableKeyValsToBuffer (lua_State state, int tableIndex, char cursor, unsigned int length)
	internal function for saving lua globals
int	saveLuaScriptGlobals (lua_State state, char buffer, unsigned int bufferLength)
	Serializes the scripts globals in a character buffer.
char *	loadLuaScriptGlobals (lua_State state, const char buffer, int tableIndex)
	Loads the scripts globals from a character buffer.
int	luaVRFTask_Template (lua_State *L, DtTaskCommandCreationFcn taskCreationFcn)
	Template functions used to factor out common code among all the VRF task and set lua commands.
int	luaVRFSet_Template (lua_State *L, DtSetCommandCreationFcn setCreationFcn)
DtSimTask *	createDisembarkTask (lua_State L, DtVrfObject vrfObject)
	VRF Task/set creation functions.
DtSimTask *	createDisembarkAllTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createEmbarkOnTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createFireAtTargetTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createFireCruiseMissileTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createFireForEffectOnEntityTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createFireForEffectOnLocationTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createFireForEffectOnTargetTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createFollowEntityTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createInterceptAndDestroyTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createMoveAlongRouteTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createMoveToLocationTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createMoveToWaypointTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createPatrolBetweenTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createPatrolAlongRouteTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createSendTextMessageTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createTurnToHeadingTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createUserTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createWaitTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createWaitDurationTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createWaitElapsedTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createTaskFromName (const char taskName, lua_State L, DtVrfObject *vrfObject)
DtSimTask *	createSendRadioTask (lua_State L, DtVrfObject vrfObject)
DtSimTask *	createSendRadioSet (lua_State L, DtVrfObject vrfObject)
DtSetDataRequest *	createDestroyedSetCommand (lua_State L, DtVrfObject vrfObject)
DtSetDataRequest *	createDisembarkedSetCommand (lua_State L, DtVrfObject vrfObject)
DtSetDataRequest *	createEmbarkedSetCommand (lua_State L, DtVrfObject vrfObject)
DtSetDataRequest *	createHeadingSetCommand (lua_State L, DtVrfObject vrfObject)
DtSetDataRequest *	createLocationSetCommand (lua_State L, DtVrfObject vrfObject)
DtSetDataRequest *	createOrderedSpeedSetCommand (lua_State L, DtVrfObject vrfObject)
DtSetDataRequest *	createPostureSetCommand (lua_State L, DtVrfObject vrfObject)
DtSetDataRequest *	createRestoreSetCommand (lua_State L, DtVrfObject vrfObject)
DtSetDataRequest *	createRulesOfEngagementSetCommand (lua_State L, DtVrfObject vrfObject)
DtSetDataRequest *	createSectorOfResponsibilitySetCommand (lua_State L, DtVrfObject vrfObject)
DtSetDataRequest *	createSpotReportsSetCommand (lua_State L, DtVrfObject vrfObject)
DtSetDataRequest *	createTargetSetCommand (lua_State L, DtVrfObject vrfObject)
DtSetDataRequest *	createWeaponStateSetCommand (lua_State L, DtVrfObject vrfObject)
DtSetDataRequest *	createSetFromName (const char setName, lua_State L, DtVrfObject *vrfObject)
int	luaVRFIsEmbarkedOn (lua_State *L)
	VRF lua Task commands.
int	luaVRFTask_Disembark (lua_State *L)
int	luaVRFTask_DisembarkAll (lua_State *L)
int	luaVRFTask_EmbarkOn (lua_State *L)
int	luaVRFTask_FireAtTarget (lua_State *L)
int	luaVRFTask_FireCruiseMissile (lua_State *L)
int	luaVRFTask_FireForEffectOnEntity (lua_State *L)
int	luaVRFTask_FireForEffectOnLocation (lua_State *L)
int	luaVRFTask_FireForEffectOnTarget (lua_State *L)
int	luaVRFTask_FollowEntity (lua_State *L)
int	luaVRFTask_InterceptAndDestroy (lua_State *L)
int	luaVRFTask_MoveAlongRoute (lua_State *L)
int	luaVRFTask_MoveToLocation (lua_State *L)
int	luaVRFTask_MoveToWaypoint (lua_State *L)
int	luaVRFTask_PatrolBetween (lua_State *L)
int	luaVRFTask_PatrolAlongRoute (lua_State *L)
int	luaVRFTask_SendRadioSet (lua_State *L)
int	luaVRFTask_SendRadioTask (lua_State *L)
int	luaVRFTask_SendTextMessage (lua_State *L)
int	luaVRFTask_TurnToHeading (lua_State *L)
int	luaVRFTask_UserTask (lua_State *L)
int	luaVRFTask_Wait (lua_State *L)
int	luaVRFTask_WaitDuration (lua_State *L)
int	luaVRFTask_WaitElapsed (lua_State *L)
int	luaVRFSet_Altitude (lua_State *L)
	VRF lua Set commands.
int	luaVRFSet_Destroyed (lua_State *L)
int	luaVRFSet_Disembarked (lua_State *L)
int	luaVRFSet_DIGuyAnimation (lua_State *L)
int	luaVRFSet_DIGuyAppearance (lua_State *L)
int	luaVRFSet_Embarked (lua_State *L)
int	luaVRFSet_Heading (lua_State *L)
int	luaVRFSet_Location (lua_State *L)
int	luaVRFSet_OrderedSpeed (lua_State *L)
int	luaVRFSet_Posture (lua_State *L)
int	luaVRFSet_Restore (lua_State *L)
int	luaVrfSet_RulesOfEngagement (lua_State *L)
int	luaVRFSet_SectorOfResponsibility (lua_State *L)
int	luaVRFSet_SpotReports (lua_State *L)
int	luaVRFSet_Target (lua_State *L)
int	luaVRFSet_WeaponState (lua_State *L)
int	luaVRFIsDestroyed (lua_State *L)
int	luaVRFIsTasked (lua_State *L)
int	luaVRFIsLocal (lua_State *L)
int	luaVRFIsVrfSimulatedObject (lua_State *L)
int	luaVRFIsExecutingPlan (lua_State *L)
int	luaUtilGetVRFObjectPosition (lua_State *l)
	Get State Repository information.
int	luaUtilGetVRFObjectOrientation (lua_State *l)
int	luaVRFGetObjectName (lua_State *L)
int	luaVRFGetObjectLabel (lua_State *L)
int	luaVRFGetOverlayParent (lua_State *L)
int	luaVRFGetEntityIdentifier (lua_State *L)
int	luaVRFGetEntityType (lua_State *L)
int	luaVRFGetExtent (lua_State *L)
int	luaVRFGetHeading (lua_State *L)
int	luaVRFGetVelocity (lua_State *L)
int	luaVRFGetOrderedSpeed (lua_State *L)
int	luaVRFGetRotationalVelocity (lua_State *L)
int	luaVRFGetAcceleration (lua_State *L)
int	luaUtilSetVRFObjectPosition (lua_State *l)
	Set Commands.
int	luaUtilSetVRFObjectOrientation (lua_State *l)
int	luaVRFSetIsDestroyed (lua_State *L)
int	luaVRFSetObjectName (lua_State *L)
int	luaVRFSetObjectLabel (lua_State *L)
int	luaVRFSetOverlayParent (lua_State *L)
int	luaVRFSetEntityIdentifier (lua_State *L)
int	luaVRFSetEntityType (lua_State *L)
int	luaVRFSetHeading (lua_State *L)
int	luaVRFSetVelocity (lua_State *L)
int	luaVRFSetOrderedSpeed (lua_State *L)
int	luaVRFSetRotationalVelocity (lua_State *L)
int	luaVRFSetAcceleration (lua_State *L)
int	luaVRFGetVertexes (lua_State *L)
	Vertex Commands.
int	luaVRFAddVertex (lua_State *L)
int	luaVRFRemoveVertex (lua_State *L)

int	luaUtilInfo (lua_State *l)
	@ Functions for printing a message on the VRF entity's object console
int	luaUtilVerbose (lua_State *l)
	@ Functions for printing a message on the VRF entity's object console
int	luaUtilWarn (lua_State *l)
	@ Functions for printing a message on the VRF entity's object console
int	luaUtilError (lua_State *l)
	@ Functions for printing a message on the VRF entity's object console
int	luaUtilDebug (lua_State *l)
	@ Functions for printing a message on the VRF entity's object console
Variables
static const int	LUA_EXECUTION_OK = 0
	Error codes.
static const int	LUA_ERROR_BAD_PARAMETERS = -1
static const int	LUA_ERROR_EXECUTION_FAILURE = -2
static const int	LUA_ERROR_INVALID_ENTITY = -3
static const int	LUA_ERROR_UNKNOWN_LUA_MANAGER = -4
static const int	LUA_ERROR_REMOTE_ENTITY = -5
const char	DtLuaScriptControllerType [] = "lua-script-controller"
	String which uniquely identifies this controller.
const char	DtScriptPSRType [] = "script-psr-type"

Detailed Description

This is a set of helper functions to handle Lua calls.

Typedef Documentation

typedef DtSimTask *(* vrfLua::DtTaskCommandCreationFcn)(lua_State *L, DtVrfObject *vrfObject)

typedefs for implementing VRF lua tasks/sets

typedef DtSetDataRequest *(* vrfLua::DtSetCommandCreationFcn)(lua_State *L, DtVrfObject *vrfObject)

Function Documentation

int vrfLua::luaVRFBHAVETask_Template	(	lua_State *	L,
		DtTaskCommandCreationFcn	taskCreationFcn
	)

Template functions used to factor out common code among all the VRF task and set lua commands.

int vrfLua::luaVRFBHAVESet_Template	(	lua_State *	L,
		DtSetCommandCreationFcn	setCreationFcn
	)

int vrfLua::luaVRFTask_BHAVEMoveToWaypoint ( lua_State * L )

int vrfLua::luaVRFTask_BHAVEMoveToLocation ( lua_State * L )

int vrfLua::luaVRFTask_BHAVEMoveAlongRoute ( lua_State * L )

int vrfLua::luaVRFTask_BHAVEPatrolRoute ( lua_State * L )

int vrfLua::luaVRFTask_BHAVEPatrolBetween ( lua_State * L )

int vrfLua::luaVRFTask_BHAVEFollow ( lua_State * L )

int vrfLua::luaVRFTask_BHAVEFlee ( lua_State * L )

int vrfLua::luaVRFTask_BHAVEHide ( lua_State * L )

int vrfLua::luaVRFTask_BHAVEWander ( lua_State * L )

int vrfLua::luaVRFSet_MovementMode ( lua_State * L )

int vrfLua::luaVRFSet_Script ( lua_State * L )

DtSimTask* vrfLua::createBHAVEMoveToWaypoint	(	lua_State *	L,
		DtVrfObject *	vrfObject
	)

DtSimTask* vrfLua::createBHAVEMoveToLocation	(	lua_State *	L,
		DtVrfObject *	vrfObject
	)

DtSimTask* vrfLua::createBHAVEMoveAlongRoute	(	lua_State *	L,
		DtVrfObject *	vrfObject
	)

DtSimTask* vrfLua::createBHAVEPatrolRoute	(	lua_State *	L,
		DtVrfObject *	vrfObject
	)

DtSimTask* vrfLua::createBHAVEPatrolBetween	(	lua_State *	L,
		DtVrfObject *	vrfObject
	)

DtSimTask* vrfLua::createBHAVEFollow	(	lua_State *	L,
		DtVrfObject *	vrfObject
	)

DtSimTask* vrfLua::createBHAVEFlee	(	lua_State *	L,
		DtVrfObject *	vrfObject
	)

DtSimTask* vrfLua::createBHAVEHide	(	lua_State *	L,
		DtVrfObject *	vrfObject
	)

DtSimTask* vrfLua::createBHAVEWander	(	lua_State *	L,
		DtVrfObject *	vrfObject
	)

DtSetDataRequest* vrfLua::createMovementMode	(	lua_State *	L,
		DtVrfObject *	vrfObject
	)

DtSetDataRequest* vrfLua::createScript	(	lua_State *	L,
		DtVrfObject *	vrfObject
	)

int vrfLua::luaDrawLine ( lua_State * l )

int vrfLua::luaDrawPoint ( lua_State * l )

int vrfLua::luaCreateEntity ( lua_State * l )

int vrfLua::luaCreateAggregate ( lua_State * l )

int vrfLua::luaCreateWaypoint ( lua_State * l )

int vrfLua::luaCreateRoute ( lua_State * l )

int vrfLua::luaCreatePhaseLine ( lua_State * l )

int vrfLua::luaCreateControlArea ( lua_State * l )

int vrfLua::luaCreateObstacle ( lua_State * l )

int vrfLua::luaCreateDisagregateArea ( lua_State * l )

int vrfLua::luaRemoveEntity ( lua_State * l )

int vrfLua::luaRemoveObject ( lua_State * l )

DT_DLL_vrfLua bool vrfLua::DtLuaFunctionExists	(	lua_State *	luaState,
		const char *	functionName
	)

Determine whether or not a function exists.

DT_DLL_vrfLua bool vrfLua::DtLuaRun	(	lua_State *	luaState,
		const char *	functionName
	)

Execute a lua function.

DT_DLL_vrfLua bool vrfLua::DtLuaRun	(	lua_State *	luaState,
		const char *	func,
		const char *	sig,
			...
	)

Execite a lua function with arguments. Example: DtLuaRun("f", "dd>d", x, y, &z);.

DT_DLL_vrfLua int vrfLua::DtLuaReport	(	lua_State *	L,
		int	status
	)

Lua Debugging functions.

DT_DLL_vrfLua void vrfLua::DtLuaStackDump ( lua_State * state )

DT_DLL_vrfLua void vrfLua::DtLuaPrintValue	(	lua_State *	state,
		int	index,
		DtOutputStream &	stream
	)

DT_DLL_vrfLua void vrfLua::DtLuaPrintTable	(	lua_State *	state,
		int	index,
		DtOutputStream &	stream
	)

DT_DLL_vrfLua int vrfLua::DtLuaErrorHandler ( lua_State * L )

DT_DLL_vrfLua int vrfLua::DtLuaAppendPath	(	lua_State *	L,
		const char *	path
	)

Add a path into Lua for include files.

DT_DLL_vrfLua DtVrfObject* vrfLua::DtLuaGetThisVRFObject ( lua_State * l )

returns the C++ equivalent of that VRF Object "this"

DT_DLL_vrfLua DtVrfObject* vrfLua::DtLuaPopVRFObject ( lua_State * l )

If a Lua VRF Object is the first item in the stack, this returns the C++ equivalent of that VRF Object and removes out of the stack.

DT_DLL_vrfLua DtVrfObject* vrfLua::DtLuaGetVRFObject ( lua_State * l )

If a Lua VRF Object is the first item in the stack, this returns the C++ equivalent of that VRF Object.

The Lua object, if it exists, remains in the stack.

int vrfLua::luaUtilInfo ( lua_State * l )