VR-Forces 5.0.1 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Classes | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtLuaScriptInterfaceImpl Class Reference

Related Examples
Inheritance diagram for DtLuaScriptInterfaceImpl:
Inheritance graph
[legend]

Classes

class  DtLuaScriptFunctionReference
 
struct  LuaExtension
 

Public Member Functions

virtual ~DtLuaScriptInterfaceImpl ()
 
virtual void init ()
 
virtual DtString type () const
 
virtual bool invokeInit ()
 
virtual void invokeSuspend ()
 
virtual bool invokeResume ()
 
virtual void invokeTick ()
 
virtual bool invokeCheck ()
 
virtual void invokeCheckInit ()
 
virtual void invokeShutdown ()
 
virtual void invokeUpdateDisplayGraph ()
 
virtual void invokeDisable ()
 
virtual bool loadScript (bool reload)
 
virtual void setLuaState (lua_State *L)
 
virtual lua_State * getLuaState ()
 
virtual std::string dumpLuaStack () const
 
virtual int luaStackSize () const
 
virtual void collectGarbage ()
 
virtual DtReaderWritersaveState ()
 
virtual bool loadState (const DtReaderWriter *loadState)
 
virtual void processClearForReuse ()
 
virtual bool initializeVRFLuaExtensions (lua_State *L)
 
virtual bool importTaskParams (lua_State *L)
 
virtual bool importSetParams (lua_State *L)
 
virtual luabind::object createLuaTableFromRegistry (lua_State *L, const DtReaderWriterRegistry &rwRegistry, bool requireMetadata=true, bool hasParamMetaData=true)
 
void luaEndTask (bool success)
 
void luaEndSet ()
 
void luaSendReportWithoutRecipients (const ::std::string reportType, luabind::object const &parameters)
 
void luaSendReport (const ::std::string reportType, luabind::object const &reciptients, luabind::object const &parameters)
 
int luaSendTask (DtScriptVrfObject &object, const ::std::string taskName, luabind::object const &parameters)
 
int luaSendTaskActAsSubtask (DtScriptVrfObject &object, const ::std::string taskName, luabind::object const &parameters, bool actAsSubtask)
 
int luaSendRadioTask (DtScriptVrfObject &object, const ::std::string taskName, luabind::object const &parameters)
 
int luaSendRadioTaskActAsSubtask (DtScriptVrfObject &object, const ::std::string taskName, luabind::object const &parameters, bool actAsSubtask)
 
int luaSendTaskActAsSubtaskWithRadio (DtScriptVrfObject &object, const ::std::string taskName, luabind::object const &parameters, bool actAsSubtask, bool sendWithRadio)
 
void luaStopAllTasks ()
 
void luaSendSetDataToSelf (const ::std::string setName, luabind::object const &parameters)
 
void luaSendSetData (DtScriptVrfObject &object, const ::std::string setName, luabind::object const &parameters)
 
void luaSendRadioSetData (DtScriptVrfObject &object, const ::std::string setName, luabind::object const &parameters)
 
void sendSetDataWithRadio (DtScriptVrfObject &object, const ::std::string setName, luabind::object const &parameters, bool useRadio)
 
bool luaIsTaskAvailable (const ::std::string taskName)
 
bool luaIsSetAvailable (const ::std::string setName)
 
luabind::object luaGetReactionStatus ()
 
luabind::object luaGetOrbatList ()
 
std::string luaGetScriptId ()
 
std::string luaGetSystemName ()
 
luabind::object luaGetObjectsNear (const DtLocation3D &loc, double distance)
 
luabind::object luaGetObjectsNearWithFilter (const DtLocation3D &loc, double distance, luabind::object const &parameters)
 
luabind::object luaGetScriptAttribute (const std::string &attributeName, bool &error)
 
luabind::object luaGetVrfObjects ()
 
boost::shared_ptr< DtLuaAsyncJobgenerateRandomPoints (const luabind::object &parameters)
 
boost::shared_ptr< DtLuaAsyncJobfindNearbyPointOfInterest (const int type)
 
boost::shared_ptr< DtLuaAsyncJobfindCoverPoint (const DtLocation3D &startLocation, const DtLocation3D &threatLocation, double threatRadius, double distanceFromThreat, double range, unsigned numberOfPoints)
 
luabind::object findLadders (lua_State *L, const DtLocation3D &startLocation, double range)
 
luabind::object findLaddersWithId (lua_State *L, const DtLocation3D &startLocation, double range, const unsigned int id)
 
boost::shared_ptr< DtLuaAsyncJobfindPathToLocation (const DtLocation3D &startLocation, const DtLocation3D &destinationLocation, bool useAbstractGraphs, const DtLocation3D &avoidLocation, double avoidanceRadius)
 
DtTranslatableStream translateStringFromScript (const std::string &format)
 
boost::shared_ptr< DtLuaAsyncJobluaNavigateThroughFeatures (const luabind::object &parameters)
 
virtual boost::shared_ptr
< DtLuaAsyncJob
luaFindSinglePosition (const luabind::object &targetAreaCorners, const DtLocation3D &pivotPoint, double targetHeightMeters, double viewHeightMeters, double hideHeightMeters, double forwardBackSearchLimitMeters, double forwardBackSearchIntervalMeters, double maxSlopeDegrees)
 
virtual boost::shared_ptr
< DtLuaAsyncJob
luaFindSinglePositionDebug (const luabind::object &targetAreaCorners, const DtLocation3D &pivotPoint, double targetHeightMeters, double viewHeightMeters, double hideHeightMeters, double forwardBackSearchLimitMeters, double forwardBackSearchIntervalMeters, double maxSlopeDegrees, bool bDebug)
 
virtual boost::shared_ptr
< DtLuaAsyncJob
luaFindVehicleFightingPositions (unsigned int nPositionPairs, const luabind::object &targetAreaCorners, const DtLocation3D &originPoint, const DtVectorOffset3D &hideVolume, double shootHeight, double targetHeight, double forwardBackSearchLimit, double sideSideSearchLimit, double maxSlopeDegrees, double positionSpacing)
 
virtual boost::shared_ptr
< DtLuaAsyncJob
luaFindVehicleFightingPositionsDebug (unsigned int nPositionPairs, const luabind::object &targetAreaCorners, const DtLocation3D &originPoint, const DtVectorOffset3D &hideVolume, double shootHeight, double targetHeight, double forwardBackSearchLimit, double sideSideSearchLimit, double maxSlopeDegrees, double positionSpacing, bool useDebug)
 
virtual boost::shared_ptr
< DtLuaAsyncJob
luaFindPositionGroupsInAreaHilltop (unsigned int nPositionPairsPerGroup, const luabind::object &searchAreaVertices, const luabind::object &targetsAreaVertices, double viewHeightMeters, double coverHeightMeters, unsigned int forwardBackRangeMeters, unsigned int sideSideRangeMeters, unsigned int searchIntervalMeters, double maxSlopeDegrees, unsigned int positionsLateralSpacingMeters)
 
virtual boost::shared_ptr
< DtLuaAsyncJob
luaFindPositionGroupsInAreaHilltopDebug (unsigned int nPositionPairsPerGroup, const luabind::object &searchAreaVertices, const luabind::object &targetsAreaVertices, double viewHeightMeters, double coverHeightMeters, unsigned int forwardBackRangeMeters, unsigned int sideSideRangeMeters, unsigned int searchIntervalMeters, double maxSlopeDegrees, unsigned int positionsLateralSpacingMeters, bool useDebug)
 
virtual boost::shared_ptr
< DtLuaAsyncJob
luaFindPositionGroupsInAreaRidge (unsigned int nPositionPairsPerGroup, const luabind::object &searchAreaVertices, const luabind::object &targetsAreaVertices, unsigned int targetsAreaSampleRate, const luabind::object &tableOfDoubles)
 
virtual boost::shared_ptr
< DtLuaAsyncJob
luaFindPositionGroupsInAreaRidgeDebug (unsigned int nPositionPairsPerGroup, const luabind::object &searchAreaVertices, const luabind::object &targetsAreaVertices, unsigned int targetsAreaSampleRate, const luabind::object &tableOfDoubles, bool useDebug)
 
boost::shared_ptr< DtLuaAsyncJobgetAllEmbarkationSlots (DtScriptVrfObject &object)
 
boost::shared_ptr< DtLuaAsyncJobgetEmbarkationSlots (DtScriptVrfObject &object)
 
boost::shared_ptr< DtLuaAsyncJobgetEmbarkationSlotsFiltered (DtScriptVrfObject &object, bool bAllSlots)
 
boost::shared_ptr< DtLuaAsyncJobreserveEmbarkationSlot (DtScriptVrfObject &object, int slotNumber)
 
boost::shared_ptr< DtLuaAsyncJobgetEmbarkationEgressPoints (DtScriptVrfObject &object)
 
void luaSendMessage (const DtScriptVrfObject &receiver, const std::string &message)
 
void luaSendRadioMessage (const DtScriptVrfObject &receiver, const std::string &message)
 
void luaSendRadioMessageToUuid (const std::string &uuid, const std::string &message)
 
void luaDeleteObject (std::string const &receiver)
 
void luaDeleteScriptObject (const DtScriptVrfObject &receiver)
 
void luaSetInterest (const DtLocation3D &location, double range)
 
void luaSendObjectMessage (const DtScriptVrfObject &receiver, const std::string &messageType, const luabind::object &messageContents)
 
void luaSendRadioObjectMessage (const DtScriptVrfObject &receiver, const std::string &messageType, const luabind::object &messageContents)
 
void luaRegisterForObjectMessage (const std::string &messageType)
 
void luaUnregisterForObjectMessage (const std::string &messageType)
 
void processObjectMessage (const DtVrfObjectMessage *msg)
 
virtual void queueTextReport (const DtVrfObjectMessage *m)
 
virtual void processTextReport (const DtVrfObjectMessage *m)
 
void luaSendInfluence (const DtScriptVrfObject &target, const std::string &influenceName, luabind::object const &influenceParams)
 
virtual void queueInfluence (const makVrfEvents::DtEvent &m)
 
virtual void processInfluence (const makVrfEvents::DtEvent &m)
 
virtual void processEntityDestroyed ()
 
virtual std::vector< DtLocation3DluaMakeOffsetPoints (luabind::object const &fromPoints, const DtVectorOffset3D &offset)
 
void luaCreateSelectionGroup (const std::string &name, luabind::object const &parameters)
 
void luaFinishTest (const int status, const std::string message)
 
bool luaUpdateTaskVisualization (const std::string &visualizationName, const std::string &visualizationType, luabind::object const &parameters)
 
void luaDeleteTaskVisualization (const std::string &visualizationName)
 
void luaRequire (lua_State *L, const std::string &filename)
 
bool luaIntersectSegments2D (const DtLocation3D &p1, const DtLocation3D &p2, const DtLocation3D &p3, const DtLocation3D &p4, DtLocation3D &intersectPoint)
 
virtual void addPostSetDataCallback (const std::string &setDataType, const std::string &functionName)
 
virtual void removePostSetDataCallback (const std::string &setDataType, const std::string &functionName)
 
virtual void invokePostSetDataCallback (DtScriptFunctionReferencePtr functionReference, DtSetDataRequestMessage *setDatRequest)
 
virtual luabind::object luaGetParamPropertyFromType (const std::string typeString, std::string const &paramName)
 
virtual void putObjectsFromTableIntoGlobalTable (lua_State *state, luabind::object &table)
 
virtual void putObjectsFromGlobalTableIntoTable (lua_State *state, luabind::object &table)
 
virtual luabind::object luaGetSubordinateFunctionNames ()
 
virtual luabind::object luaGetParameterSubordinateFunctionsFromType (const std::string typeString)
 
virtual void connectForCallbacks ()
 
virtual void processEvents ()
 
boost::shared_ptr< DtLuaAsyncJobluaGetWeaponSystemsInfo (DtScriptVrfObject &object)
 
virtual void luaPlayScenarioEvent (DtScriptVrfObject eventName)
 
virtual void luaStopScenarioEvent (DtScriptVrfObject eventName)
 
virtual void luaStopScenarioEventWithRewind (DtScriptVrfObject eventName, bool rewind)
 
virtual bool luaIsScenarioEventPlaying (DtScriptVrfObject eventName)
 
virtual void luaSetScenarioEventEnabled (DtScriptVrfObject eventName, bool)
 
virtual bool luaIsScenarioEventEnabled (DtScriptVrfObject eventName)
 
virtual int luaSendEmbeddedEntityTask (std::string eeName, std::string taskName, luabind::object const &parms)
 
virtual int luaSendEmbeddedEntityTaskActAsSubtask (std::string eeName, std::string taskName, luabind::object const &parms, bool actAsSubtask)
 
virtual int luaSendEmbeddedEntitySet (std::string eeName, std::string setName, luabind::object const &parms)
 
int luaStartSubtask (const std::string taskName, luabind::object const &parameters)
 
void luaStopSubtask (int subtaskId)
 
void luaStopAllSubtasks ()
 
bool luaIsSubtaskRunning (int subtaskId)
 
bool luaIsSubtaskComplete (int subtaskId)
 
bool luaIsSubtaskCanceled (int subtaskId)
 
bool luaSubtaskResult (int subtaskId)
 
void luaCleanupInactiveSubtaskStatus ()
 
luabind::object luaGetDesignatorsNearWithFilter (const DtLocation3D &loc, double distance, const luabind::object &params)
 
luabind::object luaGetDesignatorsNear (const DtLocation3D &loc, double distance)
 
DtLuaFeatureSet luaGetFeaturesWithinArea (luabind::object const &points, luabind::object const &attributes)
 
DtLuaFeatureSet luaGetFeaturesWithinAreaNoAttributes (luabind::object const &points)
 
DtLuaFeatureSet luaGetFeaturesWithinRange (const DtLocation3D &, double range, luabind::object const &attributes)
 
DtLuaFeatureSet luaGetFeaturesWithinRangeNoAttributes (const DtLocation3D &, double range)
 
DtLuaFeatureSet luaGetFeaturesType (const std::string &type)
 
DtLuaFeatureSet luaGetFeatures ()
 
DtLuaFeatureGeometry luaMakePointGeometry (const DtLocation3D &)
 
DtLuaFeatureGeometry luaMakePathGeometry (luabind::object const &table)
 
DtLuaFeatureGeometry luaMakeAreaGeometry (luabind::object const &table)
 
virtual boost::shared_ptr
< DtLuaAsyncJob
luaFindHighPoints (const luabind::object &corners, unsigned int nPoints)
 
virtual boost::shared_ptr
< DtLuaAsyncJob
luaFindHighPointsDebug (const luabind::object &corners, unsigned int nPoints, bool bDebug)
 
luabind::object luaGetCloudLayerDescriptionsAt (lua_State *L, const DtLocation3D &location)
 
virtual double luaGetIllumination (DtScriptVrfObject &object)
 
virtual double luaGetExpectedIllumination (DtScriptVrfObject &object, double dateAndTimeOfDay)
 
virtual double luaGetSnowAccumulationByLocation (const DtLocation3D &object)
 
virtual double luaGetSnowRoadAccumulationByLocation (const DtLocation3D &object)
 
virtual double luaGetRainAccumulationByLocation (const DtLocation3D &object)
 
virtual double luaGetAirTemperatureByLocation (const DtLocation3D &object)
 
virtual double luaGetAirPressureByLocation (const DtLocation3D &object)
 
virtual unsigned int luaGetPrecipitationByLocation (const DtLocation3D &location, double *)
 
virtual double luaGetPrecipitationIntensityByLocation (const DtLocation3D &object)
 
virtual unsigned int luaGetPrecipitationTypeByLocation (const DtLocation3D &object)
 
virtual double luaGetVisibilityDistanceByLocation (const DtLocation3D &object)
 
virtual int luaGetVisibilityObscurantByLocation (const DtLocation3D &object)
 
virtual double luaGetWindDirectionByLocation (const DtLocation3D &object)
 
virtual double luaGetWindSpeedByLocation (const DtLocation3D &object)
 
virtual double luaGetUnderwaterVisibilityByLocation (const DtLocation3D &object)
 
virtual unsigned int luaGetSwellStateByLocation (const DtLocation3D &object)
 
virtual double luaGetSwellStateDirectionByLocation (const DtLocation3D &object)
 
virtual unsigned int luaGetSeaStateByLocation (const DtLocation3D &object)
 
virtual double luaGetSeaStateDirectionByLocation (const DtLocation3D &object)
 
virtual double luaGetSurgeDepthByLocation (const DtLocation3D &object)
 
virtual double luaGetIlluminationByLocation (const DtLocation3D &object)
 
virtual double luaGetExpectedIlluminationByLocation (const DtLocation3D &object, double dateAndTimeOfDay)
 
virtual double luaRunDurationTime ()
 
virtual void luaRunForDuration (double)
 
virtual void luaStopSimulationDurationTimer ()
 
virtual void luaSetCheckpointMode (bool)
 
virtual void initializeCheckpointStateTable (lua_State *L)
 
virtual int luaAskUserQuestion (const DtTranslatableStream &title, const DtTranslatableStream &message, luabind::object const &options, int displayFlags)
 
virtual int luaAskUserQuestionST (const std::string &title, const DtTranslatableStream &message, luabind::object const &options, int displayFlags)
 
virtual int luaAskUserQuestionTS (const DtTranslatableStream &title, const std::string &message, luabind::object const &options, int displayFlags)
 
virtual int luaAskUserQuestionSS (const std::string &title, const std::string &message, luabind::object const &options, int displayFlags)
 
virtual int luaStatusOfUserQuestion (int questionId)
 
virtual void luaCancelUserQuestion (int questionId)
 
DtScriptVrfObject luaCreateEntity (luabind::object const &parameters)
 
void luaCreateEntityParallel (luabind::object const &parameters)
 
DtScriptVrfObject luaCreateFromOrbat (std::string orbatItem, const DtLocation3D &loc)
 
DtScriptVrfObject luaCreateTacticalGraphic (luabind::object const &parameters)
 
DtScriptVrfObject luaCreateObstacle (luabind::object const &parameters)
 
DtScriptVrfObject luaCreateRoute (luabind::object const &parameters)
 
DtScriptVrfObject luaCreateArea (luabind::object const &parameters)
 
DtScriptVrfObject luaCreateWaypoint (luabind::object const &parameters)
 
DtScriptVrfObject luaCreatePhaseLine (luabind::object const &parameters)
 
unsigned luaBitwiseOr (unsigned val1, unsigned val2)
 
unsigned luaBitwiseAnd (unsigned val1, unsigned val2)
 
unsigned luaBitwiseXor (unsigned val1, unsigned val2)
 
unsigned luaBitwiseNot (unsigned val)
 
unsigned luaBitwiseLeftShift (unsigned val, unsigned shift)
 
unsigned luaBitwiseRightShift (unsigned val, unsigned shift)
 
- Public Member Functions inherited from DtScriptInterface
virtual ~DtScriptInterface ()
 
virtual void setTaskId (int taskId)
 
virtual int taskId () const
 
virtual void setScriptId (const DtString &scriptId)
 
virtual const
DtGenericMessageType
scriptId () const
 
virtual void setSystemName (const DtString &system)
 
virtual const DtStringsystemName () const
 
virtual void setScriptPath (const DtFilename &scriptPath)
 
virtual const DtFilename & scriptPath () const
 
virtual void setEntity (DtLocalObject *entity)
 
virtual DtLocalObjectentity () const
 
virtual void setTaskVariables (const DtRwVariableBindings &variables)
 
virtual const
DtRwVariableBindings
taskVariables () const
 
virtual bool updateTaskVariables ()
 
virtual void setTaskStarting (bool v)
 
virtual bool taskStarting () const
 
virtual bool isGraphCapable () const
 
virtual void setIsGraphCapable (bool isCapable=true)
 
virtual bool shouldGenerateGraphOutput () const
 
virtual void setShouldGenerateGraphOutput (const bool doGenerate, const DtUUID &sender)
 
virtual void processGraphCommands (const std::string &dotFileName)
 
virtual void setController (DtScriptTaskControllerInterface *controller)
 
virtual
DtScriptTaskControllerInterface
controller ()
 
virtual double getTerrainAltitude (const double lat, const double lon, bool &dataAvailable, std::string &surface) const
 
virtual double getTerrainAltitudeBelow (const DtLocation3D &point, bool &available, std::string &surfaceString) const
 
virtual double getGroundAltitude (const double lat, const double lon, bool &isWater, bool &dataAvailable)
 
virtual void chordIntersectionDebug (const DtLocation3D &startLoc, const DtLocation3D &endLoc)
 
virtual bool doesChordHitTerrain (const DtLocation3D &pt1, const DtLocation3D &pt2, bool &dataAvailable) const
 
bool chordIntersectsTerrain (const DtLocation3D &pt1, const DtLocation3D &pt2, bool &dataAvailable, DtLocation3D &intersection) const
 
virtual DtLocation3D findClosestPointInNavigationArea (const DtLocation3D &point, bool &error) const
 
virtual DtLocation3D findClosestPointInNavigationAreaInRadius (const DtLocation3D &point, const double radius, bool &error) const
 
virtual DtLocation3D findClosestPointInNavigationAreaInRadiusAndVertLimit (const DtLocation3D &point, const double radius, const double verticalLimit, bool &error) const
 
bool findFarthestPositionAlongHeading (const DtLocation3D &point, const double heading, const double maxDistance, DtLocation3D &stopPoint, double &distanceReached) const
 
virtual DtLocation3D findClosestPointToRoad (const DtLocation3D &point, double searchRadius, bool &dataAvailable, bool &success, DtLocation3D &endA, DtLocation3D &endB, double &offsetToOutsideLane) const
 
virtual std::list< std::string > getDynamicTerrainFeatureChangeTypes (const DtLocation3D &location, double radius, bool &dataVailable)
 
virtual std::list< DtLocation3DgetDynamicTerrainFeatureLocationsForChangeType (const std::string &changeType, const DtLocation3D &location, double radius, bool &dataVailable)
 
virtual std::list< std::string > getDynamicTerrainFeatureValuesForChangeType (const std::string &changeType, const DtLocation3D &location, double radius, bool &dataVailable)
 
virtual void changeDynamicTerrain (const std::string &changeType, const std::string &changeValue, const DtLocation3D &location, double radius)
 
bool forcesHostile (std::string force1, std::string force2)
 
std::list< std::string > entityTypesForEquipment (const std::string &equipmentType)
 
virtual double gaussian ()
 
virtual void setGraphCapable ()
 
virtual void setTaskResuming (bool v)
 
virtual bool taskResuming () const
 
virtual void setIsBackgroundProces (bool isBgProc)
 
virtual bool isBackgroundProcess () const
 
virtual void setIsSet (bool isSet)
 
virtual bool isSet () const
 
double scriptGetExerciseTime ()
 
int scriptGetApplicationId ()
 
double scriptGetSimulationTime ()
 
double scriptGetTimeMultiplier ()
 
double scriptGetTimeOfDay ()
 
double scriptGetDateAndTimeOfDay ()
 
double scriptGetWindSpeed ()
 
double scriptGetWindDirection ()
 
double scriptGetMagneticDeclination (const DtLocation3D &location)
 
DtScriptVrfObject scriptGetVrfObjectByName (const std::string name)
 
DtScriptVrfObject scriptGetVrfObjectByUUID (const std::string name)
 
void printError (const std::string message)
 
void printErrorToChannel (const std::string channel, const std::string message)
 
void printErrorTranslatableStream (const DtTranslatableStream &message)
 
void printWarn (const std::string message)
 
void printWarnToChannel (const std::string channel, const std::string message)
 
void printWarnTranslatableStream (const DtTranslatableStream &message)
 
void printInfo (const std::string message)
 
void printInfoToChannel (const std::string channel, const std::string message)
 
void printInfoTranslatableStream (const DtTranslatableStream &message)
 
void printVerbose (const std::string message)
 
void printVerboseToChannel (const std::string channel, const std::string message)
 
void printVerboseTranslatableStream (const DtTranslatableStream &message)
 
void printDebug (const std::string message)
 
void printDebugToChannel (const std::string channel, const std::string message)
 
void printDebugTranslatableStream (const DtTranslatableStream &message)
 
bool entityTypeMatches (const std::string &, const std::string &)
 
void setTickPeriod (double)
 
void setTickWhilePaused (bool)
 
void setRespondToNewSensorContacts (bool)
 
virtual void addPostSetDataCallback (const DtSetMessageType &setDataType, DtScriptFunctionReferencePtr functionReference)
 
virtual void removePostSetDataCallback (const DtSetMessageType &setDataType, DtScriptFunctionReferencePtr functionReference)
 
virtual void clearPostSetDataCallbacks ()
 
virtual void processPostSetData (DtSimMessage *msg)
 
virtual void processPostTick ()
 

Static Public Member Functions

static DtScriptInterfacecreator (DtSimulationServices *)
 
static void addLuaScriptInterfaceExtension (DtLuaScriptInterfaceExtension::CreatorFcn extension, void *usr)
 
static void addLuaScriptInterfaceExtension (DtLuaScriptInterfaceExtension::CreatorFcn extension, const DtLocalObject *onlyForEntity, void *usr)
 
static void removeLuaScriptInterfaceExtension (DtLuaScriptInterfaceExtension::CreatorFcn extension, void *usr)
 
static void removeLuaScriptInterfaceExtension (DtLuaScriptInterfaceExtension::CreatorFcn extension, const DtLocalObject *onlyForEntity, void *usr)
 
static void addKeyToIgnore (const std::string &)
 
static void removeKeyToIgnore (const std::string &)
 
static void textReportCallback (const DtVrfObjectMessage *m, void *usr)
 
static void addReaderWriterToLuaTableFunction (const DtString &, ReaderWriterToLuaTableFcn)
 
- Static Public Member Functions inherited from DtScriptInterface
static void postSetDataCallback (DtSimMessage *msg, void *usr)
 
static void postTickCallback (void *usr)
 

Protected Types

typedef std::vector
< DtLuaScriptInterfaceExtension * > 
LocalInterfaceExtensions
 
typedef std::vector< LuaExtensionGlobalInterfaceExtensions
 
typedef std::map< DtString,
ReaderWriterToLuaTableFcn
ReaderWriterToLuaTableMap
 

Protected Member Functions

 DtLuaScriptInterfaceImpl (DtSimulationServices *)
 
 DtLuaScriptInterfaceImpl (const DtLuaScriptInterfaceImpl &other)
 
DtLuaScriptInterfaceImploperator= (const DtLuaScriptInterfaceImpl &other)
 
virtual bool callLuaNoArgFunction (const std::string &functionName, bool *functionExists=0)
 
virtual void updateFuncCallCount ()
 
- Protected Member Functions inherited from DtScriptInterface
 DtScriptInterface (DtSimulationServices *)
 
 DtScriptInterface (const DtScriptInterface &other)
 
DtScriptInterfaceoperator= (const DtScriptInterface &other)
 
virtual void scriptTaskComplete (bool success)
 
virtual void scriptTaskError ()
 
virtual bool scriptText (DtString &text)
 
virtual bool scriptPath (DtString &path)
 
virtual const DtReaderWritergetTaskParam (const DtString &paramName)
 
virtual bool getParamMetaDataType (const DtString &paramName, DtString &typeName)
 

Protected Attributes

lua_State * myLState
 
unsigned myFuncCallCount
 
bool myLuaScriptWarningShown
 
LocalInterfaceExtensions myInterfaceExtensions
 
luabind::object * myCheckpointStateTable
 
DtLuaMessageInterfacemyMessageInterface
 
boost::signals2::scoped_connection myInfluenceEventConnection
 
std::vector< DtVrfObjectMessage * > myTextReportCallbacks
 
std::vector
< makVrfEvents::DtEvent * > 
myInfluenceEvents
 
- Protected Attributes inherited from DtScriptInterface
int myTaskId
 
DtGenericMessageType myScriptId
 
DtString mySystemName
 
DtFilename myScriptPath
 
DtScriptTaskControllerInterfacemyControllerInterface
 
DtLocalObjectmyEntity
 
DtSimulationServicesmySimulationServices
 
DtRwVariableBindings myTaskVariables
 
bool myTaskStarting
 
bool myTaskResuming
 
bool myIsBackgroundProcess
 
bool myIsSet
 
DtPostSetDataCallbackSet mySetDataCallbacks
 
DtSetDataMessageVector mySetDataMessages
 
DtPostCallbackEntryPendingChanges myPendingSetDataCallbackEntries
 
DtSetDataMessageVector myPendingSetDataMessages
 
bool myExecutingSetDataCallbacks
 
bool myIsGraphCapable
 
bool myShouldGenerateGraphOutput
 
DtUUID myGraphRecipient
 
bool myCantFindDotMsg
 

Static Protected Attributes

static GlobalInterfaceExtensions theLuaInterfaceExtensions
 
static ReaderWriterToLuaTableMap theReaderWriterToLuaTableMap
 

Additional Inherited Members

- Public Types inherited from DtScriptInterface
typedef boost::shared_ptr
< DtScriptFunctionReference
DtScriptFunctionReferencePtr
 
typedef std::pair
< DtGenericMessageType,
DtScriptFunctionReferencePtr
DtPostCallbackEntry
 
typedef std::set
< DtPostCallbackEntry,
PostSetDataCallbackLessThan
DtPostSetDataCallbackSet
 
typedef std::vector
< DtSimMessage * > 
DtSetDataMessageVector
 
typedef std::map
< DtPostCallbackEntry, bool
DtPostCallbackEntryPendingChanges
 

Member Typedef Documentation

Constructor & Destructor Documentation

DtLuaScriptInterfaceImpl::DtLuaScriptInterfaceImpl ( DtSimulationServices )
protected
DtLuaScriptInterfaceImpl::DtLuaScriptInterfaceImpl ( const DtLuaScriptInterfaceImpl other)
protected
virtual DtLuaScriptInterfaceImpl::~DtLuaScriptInterfaceImpl ( )
virtual

Member Function Documentation

DtLuaScriptInterfaceImpl& DtLuaScriptInterfaceImpl::operator= ( const DtLuaScriptInterfaceImpl other)
protected
static DtScriptInterface* DtLuaScriptInterfaceImpl::creator ( DtSimulationServices )
static
virtual void DtLuaScriptInterfaceImpl::init ( )
virtual

Derived class inits may do things, so init should always be called.

Reimplemented from DtScriptInterface.

virtual DtString DtLuaScriptInterfaceImpl::type ( ) const
virtual

Script engine type.

Implements DtScriptInterface.

virtual bool DtLuaScriptInterfaceImpl::invokeInit ( )
virtual

Implements DtScriptInterface.

virtual void DtLuaScriptInterfaceImpl::invokeSuspend ( )
virtual

Implements DtScriptInterface.

virtual bool DtLuaScriptInterfaceImpl::invokeResume ( )
virtual

Implements DtScriptInterface.

virtual void DtLuaScriptInterfaceImpl::invokeTick ( )
virtual

This will be called by the parent to invoke the script tick.

Implements DtScriptInterface.

virtual bool DtLuaScriptInterfaceImpl::invokeCheck ( )
virtual

Implements DtScriptInterface.

virtual void DtLuaScriptInterfaceImpl::invokeCheckInit ( )
virtual

Implements DtScriptInterface.

virtual void DtLuaScriptInterfaceImpl::invokeShutdown ( )
virtual

Implements DtScriptInterface.

virtual void DtLuaScriptInterfaceImpl::invokeUpdateDisplayGraph ( )
virtual

Called when graphs are enabled to get an immediate graph output.

Implements DtScriptInterface.

virtual void DtLuaScriptInterfaceImpl::invokeDisable ( )
virtual

Only called for reactive tasks which can be enabled but not active. When the task is completely disabled, this should be invoked.

Implements DtScriptInterface.

virtual bool DtLuaScriptInterfaceImpl::loadScript ( bool  reload)
virtual

This will be called by the parent to let the interface know when to load the script.

Implements DtScriptInterface.

virtual void DtLuaScriptInterfaceImpl::setLuaState ( lua_State *  L)
virtual
virtual lua_State* DtLuaScriptInterfaceImpl::getLuaState ( )
virtual
virtual std::string DtLuaScriptInterfaceImpl::dumpLuaStack ( ) const
virtual
virtual int DtLuaScriptInterfaceImpl::luaStackSize ( ) const
virtual
virtual void DtLuaScriptInterfaceImpl::collectGarbage ( )
virtual
virtual DtReaderWriter* DtLuaScriptInterfaceImpl::saveState ( )
virtual

Called when the scenario is saved. The stateState pointer may not be valid, in which case something went wrong with saving.

Implements DtScriptInterface.

virtual bool DtLuaScriptInterfaceImpl::loadState ( const DtReaderWriter savedState)
virtual

Called when the scenario is loaded. The load state pointer may not be valid, which does not indicate that the scenario loaded incorrectly, but that the data for this particular script interface was either corrupt or did not exist.

Implements DtScriptInterface.

virtual void DtLuaScriptInterfaceImpl::processClearForReuse ( )
virtual

This function should be overridden by the inheritor to clear out any task specific variables. This version should probably be called last if you override it rather than first to take care of things before these things get cleared. Note: This function should only be used when a script interface is being reused between different controllers/vrfObjects (to keep from having to delete and recreate the script interface).

Reimplemented from DtScriptInterface.

static void DtLuaScriptInterfaceImpl::addLuaScriptInterfaceExtension ( DtLuaScriptInterfaceExtension::CreatorFcn  extension,
void *  usr 
)
static

Add a new extension creator function. This creator will be called every time a new lua environment is created. Will be applied to all entities.

Parameters
usrA pointer that will be passed to the creator function when called.
static void DtLuaScriptInterfaceImpl::addLuaScriptInterfaceExtension ( DtLuaScriptInterfaceExtension::CreatorFcn  extension,
const DtLocalObject onlyForEntity,
void *  usr 
)
static

Add a new extension creator function. This creator will be called every time a new lua environment is created.

Parameters
onlyForEntityOnly invoke the creator if the entity being tasked is the entity this is registered for
usrA pointer that will be passed to the creator function when called.
static void DtLuaScriptInterfaceImpl::removeLuaScriptInterfaceExtension ( DtLuaScriptInterfaceExtension::CreatorFcn  extension,
void *  usr 
)
static

Remove an extension.

static void DtLuaScriptInterfaceImpl::removeLuaScriptInterfaceExtension ( DtLuaScriptInterfaceExtension::CreatorFcn  extension,
const DtLocalObject onlyForEntity,
void *  usr 
)
static

Removes only for particular entity if registered for that entity. If there is one registered for all entities and none registered for this entity then no action is taken.

virtual bool DtLuaScriptInterfaceImpl::initializeVRFLuaExtensions ( lua_State *  L)
virtual
virtual bool DtLuaScriptInterfaceImpl::importTaskParams ( lua_State *  L)
virtual
virtual bool DtLuaScriptInterfaceImpl::importSetParams ( lua_State *  L)
virtual

Same as importTaskParameters, except puts in lua block "setParameters".

virtual luabind::object DtLuaScriptInterfaceImpl::createLuaTableFromRegistry ( lua_State *  L,
const DtReaderWriterRegistry rwRegistry,
bool  requireMetadata = true,
bool  hasParamMetaData = true 
)
virtual

Converts a readerWriter registry into a lua table.

static void DtLuaScriptInterfaceImpl::addKeyToIgnore ( const std::string &  )
static

When serializing ignore any key found in this list. Uses instance of luaObjectSerializer.

static void DtLuaScriptInterfaceImpl::removeKeyToIgnore ( const std::string &  )
static

Removes a key to ignore during serialization Uses instance of luaObjectSerializer.

void DtLuaScriptInterfaceImpl::luaEndTask ( bool  success)

Admin functions called from Lua.

void DtLuaScriptInterfaceImpl::luaEndSet ( )
virtual void DtLuaScriptInterfaceImpl::luaPlayScenarioEvent ( DtScriptVrfObject  eventName)
virtual

Global functions that have Lua-specific dependencies.

Scenario event commands

virtual void DtLuaScriptInterfaceImpl::luaStopScenarioEvent ( DtScriptVrfObject  eventName)
virtual

Global functions that have Lua-specific dependencies.

Scenario event commands

virtual void DtLuaScriptInterfaceImpl::luaStopScenarioEventWithRewind ( DtScriptVrfObject  eventName,
bool  rewind 
)
virtual

Global functions that have Lua-specific dependencies.

Scenario event commands

virtual bool DtLuaScriptInterfaceImpl::luaIsScenarioEventPlaying ( DtScriptVrfObject  eventName)
virtual

Global functions that have Lua-specific dependencies.

Scenario event commands

virtual void DtLuaScriptInterfaceImpl::luaSetScenarioEventEnabled ( DtScriptVrfObject  eventName,
bool   
)
virtual

Global functions that have Lua-specific dependencies.

Scenario event commands

virtual bool DtLuaScriptInterfaceImpl::luaIsScenarioEventEnabled ( DtScriptVrfObject  eventName)
virtual

Global functions that have Lua-specific dependencies.

Scenario event commands

virtual int DtLuaScriptInterfaceImpl::luaSendEmbeddedEntityTask ( std::string  eeName,
std::string  taskName,
luabind::object const &  parms 
)
virtual

Task/set forwarding for embedded entities.

Send a task to an Embedded Entity, implicitly deploying it if necessary.

virtual int DtLuaScriptInterfaceImpl::luaSendEmbeddedEntityTaskActAsSubtask ( std::string  eeName,
std::string  taskName,
luabind::object const &  parms,
bool  actAsSubtask 
)
virtual

Task/set forwarding for embedded entities.

Send a task to an Embedded Entity, implicitly deploying it if necessary.

virtual int DtLuaScriptInterfaceImpl::luaSendEmbeddedEntitySet ( std::string  eeName,
std::string  setName,
luabind::object const &  parms 
)
virtual

Send a set-data message to an Embedded Entity, implicitly deploying it if necessary.

int DtLuaScriptInterfaceImpl::luaStartSubtask ( const std::string  taskName,
luabind::object const &  parameters 
)

Subtasking related functions called from Lua.

Starts a subtask and returns the subtask ID. ID of -1 indicates it failed to start.

void DtLuaScriptInterfaceImpl::luaStopSubtask ( int  subtaskId)

Subtasking related functions called from Lua.

Starts a subtask and returns the subtask ID. ID of -1 indicates it failed to start.

void DtLuaScriptInterfaceImpl::luaStopAllSubtasks ( )

Stops all subtasks that were started by this task.

bool DtLuaScriptInterfaceImpl::luaIsSubtaskRunning ( int  subtaskId)
Returns
True if this subtask has been started, and has not yet completed.
bool DtLuaScriptInterfaceImpl::luaIsSubtaskComplete ( int  subtaskId)
Returns
True if this subtask has completed running. (not canceled and not complete)
bool DtLuaScriptInterfaceImpl::luaIsSubtaskCanceled ( int  subtaskId)
Returns
True if this subtask has been canceled.
bool DtLuaScriptInterfaceImpl::luaSubtaskResult ( int  subtaskId)
Returns
True if this subtask has completed, and the completion result was success.
void DtLuaScriptInterfaceImpl::luaCleanupInactiveSubtaskStatus ( )

Clears out the subtask entries for any subtasks started by this task which are either complete or canceled. This is not typically necessary to call, unless the task creates an unbounded number of subtasks without completing itself.

void DtLuaScriptInterfaceImpl::luaSendReportWithoutRecipients ( const ::std::string  reportType,
luabind::object const &  parameters 
)

Send a DtSimReport subclass to the network (e.g. DtSpotReport)

void DtLuaScriptInterfaceImpl::luaSendReport ( const ::std::string  reportType,
luabind::object const &  reciptients,
luabind::object const &  parameters 
)
int DtLuaScriptInterfaceImpl::luaSendTask ( DtScriptVrfObject object,
const ::std::string  taskName,
luabind::object const &  parameters 
)

Send task to another entity.

int DtLuaScriptInterfaceImpl::luaSendTaskActAsSubtask ( DtScriptVrfObject object,
const ::std::string  taskName,
luabind::object const &  parameters,
bool  actAsSubtask 
)
int DtLuaScriptInterfaceImpl::luaSendRadioTask ( DtScriptVrfObject object,
const ::std::string  taskName,
luabind::object const &  parameters 
)
int DtLuaScriptInterfaceImpl::luaSendRadioTaskActAsSubtask ( DtScriptVrfObject object,
const ::std::string  taskName,
luabind::object const &  parameters,
bool  actAsSubtask 
)
int DtLuaScriptInterfaceImpl::luaSendTaskActAsSubtaskWithRadio ( DtScriptVrfObject object,
const ::std::string  taskName,
luabind::object const &  parameters,
bool  actAsSubtask,
bool  sendWithRadio 
)
void DtLuaScriptInterfaceImpl::luaStopAllTasks ( )

Stops all tasks started by this task.

void DtLuaScriptInterfaceImpl::luaSendSetDataToSelf ( const ::std::string  setName,
luabind::object const &  parameters 
)

Send a set-data message to self.

void DtLuaScriptInterfaceImpl::luaSendSetData ( DtScriptVrfObject object,
const ::std::string  setName,
luabind::object const &  parameters 
)

Send a set-data message to another entity.

void DtLuaScriptInterfaceImpl::luaSendRadioSetData ( DtScriptVrfObject object,
const ::std::string  setName,
luabind::object const &  parameters 
)
void DtLuaScriptInterfaceImpl::sendSetDataWithRadio ( DtScriptVrfObject object,
const ::std::string  setName,
luabind::object const &  parameters,
bool  useRadio 
)
bool DtLuaScriptInterfaceImpl::luaIsTaskAvailable ( const ::std::string  taskName)
bool DtLuaScriptInterfaceImpl::luaIsSetAvailable ( const ::std::string  setName)
luabind::object DtLuaScriptInterfaceImpl::luaGetReactionStatus ( )

Provide current reaction status to lua scripts.

luabind::object DtLuaScriptInterfaceImpl::luaGetOrbatList ( )

Returns a table of all ORBAT items and their information. Each table entry will be another table entry with the following values: markingText - The marking text of the ORBAT item entityType - Entity type of the ORBAT type uuid - uuid of the ORBAT item parentUUID - parentUUUID of the ORBAT item (or blank) force - force of the ORBAT item created - true if created.

std::string DtLuaScriptInterfaceImpl::luaGetScriptId ( )

Provide the current script ID to lua scripts.

std::string DtLuaScriptInterfaceImpl::luaGetSystemName ( )

Provide the current system name to lua scripts.

luabind::object DtLuaScriptInterfaceImpl::luaGetObjectsNear ( const DtLocation3D loc,
double  distance 
)
luabind::object DtLuaScriptInterfaceImpl::luaGetObjectsNearWithFilter ( const DtLocation3D loc,
double  distance,
luabind::object const &  parameters 
)
luabind::object DtLuaScriptInterfaceImpl::luaGetScriptAttribute ( const std::string &  attributeName,
bool error 
)
luabind::object DtLuaScriptInterfaceImpl::luaGetVrfObjects ( )

Returns a list of all scripted objects.

luabind::object DtLuaScriptInterfaceImpl::luaGetDesignatorsNearWithFilter ( const DtLocation3D loc,
double  distance,
const luabind::object &  params 
)

Routes for accessing laser designators.

luabind::object DtLuaScriptInterfaceImpl::luaGetDesignatorsNear ( const DtLocation3D loc,
double  distance 
)

Routes for accessing laser designators.

DtLuaFeatureSet DtLuaScriptInterfaceImpl::luaGetFeaturesWithinArea ( luabind::object const &  points,
luabind::object const &  attributes 
)

Routines to query and return feature sets.

Returns a feature set which contains all features within the specified geometry containing the specified attributes.

DtLuaFeatureSet DtLuaScriptInterfaceImpl::luaGetFeaturesWithinAreaNoAttributes ( luabind::object const &  points)

Returns a feature set which contains all features within the specified geometry regardless of attributes.

DtLuaFeatureSet DtLuaScriptInterfaceImpl::luaGetFeaturesWithinRange ( const DtLocation3D ,
double  range,
luabind::object const &  attributes 
)

Returns a feature set which contains all features within the specified point and box size containing the specified attributes. The range is in meters. The range will create a bounding box with the point supplied at the center.

DtLuaFeatureSet DtLuaScriptInterfaceImpl::luaGetFeaturesWithinRangeNoAttributes ( const DtLocation3D ,
double  range 
)

Same as luaGetFeaturesWithinRange except returns all features regardless of attributes.

DtLuaFeatureSet DtLuaScriptInterfaceImpl::luaGetFeaturesType ( const std::string &  type)

Returns all features which match a specific feature query.

DtLuaFeatureSet DtLuaScriptInterfaceImpl::luaGetFeatures ( )

Returns all features.

DtLuaFeatureGeometry DtLuaScriptInterfaceImpl::luaMakePointGeometry ( const DtLocation3D )

Routines to generate feature geometries.

Generate a point geometry.

DtLuaFeatureGeometry DtLuaScriptInterfaceImpl::luaMakePathGeometry ( luabind::object const &  table)

Generate a path (linear) geometry.

DtLuaFeatureGeometry DtLuaScriptInterfaceImpl::luaMakeAreaGeometry ( luabind::object const &  table)

Generate an areal geometry.

boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::generateRandomPoints ( const luabind::object &  parameters)

Generates random points on the terrain using NavData.

boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::findNearbyPointOfInterest ( const int  type)

Find a nearby point in the NavData with the given type.

boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::findCoverPoint ( const DtLocation3D startLocation,
const DtLocation3D threatLocation,
double  threatRadius,
double  distanceFromThreat,
double  range,
unsigned  numberOfPoints 
)

Find nearby points of cover from the given threat location.

luabind::object DtLuaScriptInterfaceImpl::findLadders ( lua_State *  L,
const DtLocation3D startLocation,
double  range 
)

Find nearby ladders from the given location/range.

luabind::object DtLuaScriptInterfaceImpl::findLaddersWithId ( lua_State *  L,
const DtLocation3D startLocation,
double  range,
const unsigned int  id 
)

Find nearby ladders from the given location/range.

boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::findPathToLocation ( const DtLocation3D startLocation,
const DtLocation3D destinationLocation,
bool  useAbstractGraphs,
const DtLocation3D avoidLocation,
double  avoidanceRadius 
)

Find the best path to the given location.

DtTranslatableStream DtLuaScriptInterfaceImpl::translateStringFromScript ( const std::string &  format)

Returns a translatable object that can be used to send translated messages.

boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::luaNavigateThroughFeatures ( const luabind::object &  parameters)

Returns an async job object which will produce a path (set of points) from the input points. The output path object will be altered as to move around the features.

virtual boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::luaFindHighPoints ( const luabind::object &  corners,
unsigned int  nPoints 
)
virtual

Called from the lua script this method will print a message.

virtual boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::luaFindHighPointsDebug ( const luabind::object &  corners,
unsigned int  nPoints,
bool  bDebug 
)
virtual

Called from the lua script this method will print a message.

virtual boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::luaFindSinglePosition ( const luabind::object &  targetAreaCorners,
const DtLocation3D pivotPoint,
double  targetHeightMeters,
double  viewHeightMeters,
double  hideHeightMeters,
double  forwardBackSearchLimitMeters,
double  forwardBackSearchIntervalMeters,
double  maxSlopeDegrees 
)
virtual

luaFindSinglePosition() without debug option

virtual boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::luaFindSinglePositionDebug ( const luabind::object &  targetAreaCorners,
const DtLocation3D pivotPoint,
double  targetHeightMeters,
double  viewHeightMeters,
double  hideHeightMeters,
double  forwardBackSearchLimitMeters,
double  forwardBackSearchIntervalMeters,
double  maxSlopeDegrees,
bool  bDebug 
)
virtual

luaFindSinglePosition() with debug option

virtual boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::luaFindVehicleFightingPositions ( unsigned int  nPositionPairs,
const luabind::object &  targetAreaCorners,
const DtLocation3D originPoint,
const DtVectorOffset3D hideVolume,
double  shootHeight,
double  targetHeight,
double  forwardBackSearchLimit,
double  sideSideSearchLimit,
double  maxSlopeDegrees,
double  positionSpacing 
)
virtual

luaFindVehicleFightingPositions() without debug option

virtual boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::luaFindVehicleFightingPositionsDebug ( unsigned int  nPositionPairs,
const luabind::object &  targetAreaCorners,
const DtLocation3D originPoint,
const DtVectorOffset3D hideVolume,
double  shootHeight,
double  targetHeight,
double  forwardBackSearchLimit,
double  sideSideSearchLimit,
double  maxSlopeDegrees,
double  positionSpacing,
bool  useDebug 
)
virtual
virtual boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::luaFindPositionGroupsInAreaHilltop ( unsigned int  nPositionPairsPerGroup,
const luabind::object &  searchAreaVertices,
const luabind::object &  targetsAreaVertices,
double  viewHeightMeters,
double  coverHeightMeters,
unsigned int  forwardBackRangeMeters,
unsigned int  sideSideRangeMeters,
unsigned int  searchIntervalMeters,
double  maxSlopeDegrees,
unsigned int  positionsLateralSpacingMeters 
)
virtual
virtual boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::luaFindPositionGroupsInAreaHilltopDebug ( unsigned int  nPositionPairsPerGroup,
const luabind::object &  searchAreaVertices,
const luabind::object &  targetsAreaVertices,
double  viewHeightMeters,
double  coverHeightMeters,
unsigned int  forwardBackRangeMeters,
unsigned int  sideSideRangeMeters,
unsigned int  searchIntervalMeters,
double  maxSlopeDegrees,
unsigned int  positionsLateralSpacingMeters,
bool  useDebug 
)
virtual
virtual boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::luaFindPositionGroupsInAreaRidge ( unsigned int  nPositionPairsPerGroup,
const luabind::object &  searchAreaVertices,
const luabind::object &  targetsAreaVertices,
unsigned int  targetsAreaSampleRate,
const luabind::object &  tableOfDoubles 
)
virtual
virtual boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::luaFindPositionGroupsInAreaRidgeDebug ( unsigned int  nPositionPairsPerGroup,
const luabind::object &  searchAreaVertices,
const luabind::object &  targetsAreaVertices,
unsigned int  targetsAreaSampleRate,
const luabind::object &  tableOfDoubles,
bool  useDebug 
)
virtual
boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::getAllEmbarkationSlots ( DtScriptVrfObject object)

Queries all embarkation slot information for the specified entity. Calls getEmbarkationSlotsFiltered.

boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::getEmbarkationSlots ( DtScriptVrfObject object)

Queries embarkation slot information for the specified entity, if they are appropriate for the calling object. Calls getEmbarkationSlotsFiltered.

boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::getEmbarkationSlotsFiltered ( DtScriptVrfObject object,
bool  bAllSlots 
)

Queries embarkation slot information for the specified entity, optionally all of them, otherwise only those appropriate for the caller.

boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::reserveEmbarkationSlot ( DtScriptVrfObject object,
int  slotNumber 
)

Reserves an embarkation slot on the specified entity.

boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::getEmbarkationEgressPoints ( DtScriptVrfObject object)

Queries embarkation egress point information for the specified entity.

void DtLuaScriptInterfaceImpl::luaSendMessage ( const DtScriptVrfObject receiver,
const std::string &  message 
)
void DtLuaScriptInterfaceImpl::luaSendRadioMessage ( const DtScriptVrfObject receiver,
const std::string &  message 
)
void DtLuaScriptInterfaceImpl::luaSendRadioMessageToUuid ( const std::string &  uuid,
const std::string &  message 
)
void DtLuaScriptInterfaceImpl::luaDeleteObject ( std::string const &  receiver)
void DtLuaScriptInterfaceImpl::luaDeleteScriptObject ( const DtScriptVrfObject receiver)
void DtLuaScriptInterfaceImpl::luaSetInterest ( const DtLocation3D location,
double  range 
)
void DtLuaScriptInterfaceImpl::luaSendObjectMessage ( const DtScriptVrfObject receiver,
const std::string &  messageType,
const luabind::object &  messageContents 
)
void DtLuaScriptInterfaceImpl::luaSendRadioObjectMessage ( const DtScriptVrfObject receiver,
const std::string &  messageType,
const luabind::object &  messageContents 
)
void DtLuaScriptInterfaceImpl::luaRegisterForObjectMessage ( const std::string &  messageType)
void DtLuaScriptInterfaceImpl::luaUnregisterForObjectMessage ( const std::string &  messageType)
void DtLuaScriptInterfaceImpl::processObjectMessage ( const DtVrfObjectMessage msg)
static void DtLuaScriptInterfaceImpl::textReportCallback ( const DtVrfObjectMessage m,
void *  usr 
)
static
virtual void DtLuaScriptInterfaceImpl::queueTextReport ( const DtVrfObjectMessage m)
virtual
virtual void DtLuaScriptInterfaceImpl::processTextReport ( const DtVrfObjectMessage m)
virtual
void DtLuaScriptInterfaceImpl::luaSendInfluence ( const DtScriptVrfObject target,
const std::string &  influenceName,
luabind::object const &  influenceParams 
)
static void DtLuaScriptInterfaceImpl::addReaderWriterToLuaTableFunction ( const DtString ,
ReaderWriterToLuaTableFcn   
)
static

Adds a new process function for a reader/writer type.

virtual void DtLuaScriptInterfaceImpl::queueInfluence ( const makVrfEvents::DtEvent m)
virtual
virtual void DtLuaScriptInterfaceImpl::processInfluence ( const makVrfEvents::DtEvent m)
virtual
virtual void DtLuaScriptInterfaceImpl::processEntityDestroyed ( )
virtual

Performs processing that should occur when the entity is destroyed.

Reimplemented from DtScriptInterface.

luabind::object DtLuaScriptInterfaceImpl::luaGetCloudLayerDescriptionsAt ( lua_State *  L,
const DtLocation3D location 
)

Cloud layer accessors/mutators. See code or lua documentation for more specifics.

virtual double DtLuaScriptInterfaceImpl::luaGetIllumination ( DtScriptVrfObject object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual double DtLuaScriptInterfaceImpl::luaGetExpectedIllumination ( DtScriptVrfObject object,
double  dateAndTimeOfDay 
)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual double DtLuaScriptInterfaceImpl::luaGetSnowAccumulationByLocation ( const DtLocation3D object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual double DtLuaScriptInterfaceImpl::luaGetSnowRoadAccumulationByLocation ( const DtLocation3D object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual double DtLuaScriptInterfaceImpl::luaGetRainAccumulationByLocation ( const DtLocation3D object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual double DtLuaScriptInterfaceImpl::luaGetAirTemperatureByLocation ( const DtLocation3D object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual double DtLuaScriptInterfaceImpl::luaGetAirPressureByLocation ( const DtLocation3D object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual unsigned int DtLuaScriptInterfaceImpl::luaGetPrecipitationByLocation ( const DtLocation3D location,
double  
)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual double DtLuaScriptInterfaceImpl::luaGetPrecipitationIntensityByLocation ( const DtLocation3D object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual unsigned int DtLuaScriptInterfaceImpl::luaGetPrecipitationTypeByLocation ( const DtLocation3D object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual double DtLuaScriptInterfaceImpl::luaGetVisibilityDistanceByLocation ( const DtLocation3D object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual int DtLuaScriptInterfaceImpl::luaGetVisibilityObscurantByLocation ( const DtLocation3D object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual double DtLuaScriptInterfaceImpl::luaGetWindDirectionByLocation ( const DtLocation3D object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual double DtLuaScriptInterfaceImpl::luaGetWindSpeedByLocation ( const DtLocation3D object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual double DtLuaScriptInterfaceImpl::luaGetUnderwaterVisibilityByLocation ( const DtLocation3D object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual unsigned int DtLuaScriptInterfaceImpl::luaGetSwellStateByLocation ( const DtLocation3D object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual double DtLuaScriptInterfaceImpl::luaGetSwellStateDirectionByLocation ( const DtLocation3D object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual unsigned int DtLuaScriptInterfaceImpl::luaGetSeaStateByLocation ( const DtLocation3D object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual double DtLuaScriptInterfaceImpl::luaGetSeaStateDirectionByLocation ( const DtLocation3D object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual double DtLuaScriptInterfaceImpl::luaGetSurgeDepthByLocation ( const DtLocation3D object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual double DtLuaScriptInterfaceImpl::luaGetIlluminationByLocation ( const DtLocation3D object)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual double DtLuaScriptInterfaceImpl::luaGetExpectedIlluminationByLocation ( const DtLocation3D object,
double  dateAndTimeOfDay 
)
virtual

Weather related accessors. See code or lua documentation for more specifics.

virtual double DtLuaScriptInterfaceImpl::luaRunDurationTime ( )
virtual

Calls to effect how long the simulation will run.

virtual void DtLuaScriptInterfaceImpl::luaRunForDuration ( double  )
virtual

Calls to effect how long the simulation will run.

virtual void DtLuaScriptInterfaceImpl::luaStopSimulationDurationTimer ( )
virtual

Calls to effect how long the simulation will run.

virtual void DtLuaScriptInterfaceImpl::luaSetCheckpointMode ( bool  )
virtual

Routines for changing checkpoint state and initializing checkpoint state.

virtual void DtLuaScriptInterfaceImpl::initializeCheckpointStateTable ( lua_State *  L)
virtual

Routines for changing checkpoint state and initializing checkpoint state.

virtual int DtLuaScriptInterfaceImpl::luaAskUserQuestion ( const DtTranslatableStream title,
const DtTranslatableStream message,
luabind::object const &  options,
int  displayFlags 
)
virtual

Commands that are used to manage user response questions asked from lua scripts Ask the user a question. The method returns the question id that is used in subsequent question methods. The user, when the question is answered, will only return a single response Display flags are: 0 - Buttons 1 - Radio buttons 2 - Combo box.

virtual int DtLuaScriptInterfaceImpl::luaAskUserQuestionST ( const std::string &  title,
const DtTranslatableStream message,
luabind::object const &  options,
int  displayFlags 
)
virtual

Routines for changing checkpoint state and initializing checkpoint state.

virtual int DtLuaScriptInterfaceImpl::luaAskUserQuestionTS ( const DtTranslatableStream title,
const std::string &  message,
luabind::object const &  options,
int  displayFlags 
)
virtual

Routines for changing checkpoint state and initializing checkpoint state.

virtual int DtLuaScriptInterfaceImpl::luaAskUserQuestionSS ( const std::string &  title,
const std::string &  message,
luabind::object const &  options,
int  displayFlags 
)
virtual

Routines for changing checkpoint state and initializing checkpoint state.

virtual int DtLuaScriptInterfaceImpl::luaStatusOfUserQuestion ( int  questionId)
virtual

Returns the status of the user question: -1 - Not yet answered 0+ - Answered and the option the user selected.

virtual void DtLuaScriptInterfaceImpl::luaCancelUserQuestion ( int  questionId)
virtual

Cancels the question asked of the user.

DtScriptVrfObject DtLuaScriptInterfaceImpl::luaCreateEntity ( luabind::object const &  parameters)

Series of create commands that will use base DtCreateObjectBuilder to create the object and return the created object.

Create an entity

void DtLuaScriptInterfaceImpl::luaCreateEntityParallel ( luabind::object const &  parameters)

Routines for changing checkpoint state and initializing checkpoint state.

DtScriptVrfObject DtLuaScriptInterfaceImpl::luaCreateFromOrbat ( std::string  orbatItem,
const DtLocation3D loc 
)

Create an object from the ORBAT.

DtScriptVrfObject DtLuaScriptInterfaceImpl::luaCreateTacticalGraphic ( luabind::object const &  parameters)

Create a tactical graphic. Must specify name or type.

DtScriptVrfObject DtLuaScriptInterfaceImpl::luaCreateObstacle ( luabind::object const &  parameters)

Create an obstacle.

DtScriptVrfObject DtLuaScriptInterfaceImpl::luaCreateRoute ( luabind::object const &  parameters)

Create a route.

DtScriptVrfObject DtLuaScriptInterfaceImpl::luaCreateArea ( luabind::object const &  parameters)

Create an area.

DtScriptVrfObject DtLuaScriptInterfaceImpl::luaCreateWaypoint ( luabind::object const &  parameters)

Create a waypoint.

DtScriptVrfObject DtLuaScriptInterfaceImpl::luaCreatePhaseLine ( luabind::object const &  parameters)

Creates a phase line.

virtual std::vector<DtLocation3D> DtLuaScriptInterfaceImpl::luaMakeOffsetPoints ( luabind::object const &  fromPoints,
const DtVectorOffset3D offset 
)
virtual

Creates a table of Location3D objects that are offset from another table of points.

void DtLuaScriptInterfaceImpl::luaCreateSelectionGroup ( const std::string &  name,
luabind::object const &  parameters 
)

Creates a new selection group containing the specified sim objects.

void DtLuaScriptInterfaceImpl::luaFinishTest ( const int  status,
const std::string  message 
)

Support for automated testing. Executes a finish-test action, which prints the status and message to the Warn console, and then either pauses or exits the sim depending on sim options.

bool DtLuaScriptInterfaceImpl::luaUpdateTaskVisualization ( const std::string &  visualizationName,
const std::string &  visualizationType,
luabind::object const &  parameters 
)

Updates (creating if necessary) a new task visualization.

void DtLuaScriptInterfaceImpl::luaDeleteTaskVisualization ( const std::string &  visualizationName)

Deletes an existing task visualization.

void DtLuaScriptInterfaceImpl::luaRequire ( lua_State *  L,
const std::string &  filename 
)

Loads an runs a Lua library.

unsigned DtLuaScriptInterfaceImpl::luaBitwiseOr ( unsigned  val1,
unsigned  val2 
)

Series of bitwise operations.

unsigned DtLuaScriptInterfaceImpl::luaBitwiseAnd ( unsigned  val1,
unsigned  val2 
)

Series of bitwise operations.

unsigned DtLuaScriptInterfaceImpl::luaBitwiseXor ( unsigned  val1,
unsigned  val2 
)

Series of bitwise operations.

unsigned DtLuaScriptInterfaceImpl::luaBitwiseNot ( unsigned  val)

Series of bitwise operations.

unsigned DtLuaScriptInterfaceImpl::luaBitwiseLeftShift ( unsigned  val,
unsigned  shift 
)

Series of bitwise operations.

unsigned DtLuaScriptInterfaceImpl::luaBitwiseRightShift ( unsigned  val,
unsigned  shift 
)

Series of bitwise operations.

bool DtLuaScriptInterfaceImpl::luaIntersectSegments2D ( const DtLocation3D p1,
const DtLocation3D p2,
const DtLocation3D p3,
const DtLocation3D p4,
DtLocation3D intersectPoint 
)
virtual void DtLuaScriptInterfaceImpl::addPostSetDataCallback ( const std::string &  setDataType,
const std::string &  functionName 
)
virtual

virtual void DtLuaScriptInterfaceImpl::removePostSetDataCallback ( const std::string &  setDataType,
const std::string &  functionName 
)
virtual

virtual void DtLuaScriptInterfaceImpl::invokePostSetDataCallback ( DtScriptFunctionReferencePtr  functionReference,
DtSetDataRequestMessage setDatRequest 
)
virtual

Invokes a post set data callback for a lua script. functionReference must be a shared_ptr to a DtLuaScriptFunctionRefernce.

Implements DtScriptInterface.

virtual luabind::object DtLuaScriptInterfaceImpl::luaGetParamPropertyFromType ( const std::string  typeString,
std::string const &  paramName 
)
virtual

Returns an object containing the value of the requested parameter property. May be a table containing a number of fields that make up the property, or a single value. This function looks up the entry in the parameter database for the given type, not the current values in the given entity. If the property could not be found, the returned table will be empty.

virtual void DtLuaScriptInterfaceImpl::putObjectsFromTableIntoGlobalTable ( lua_State *  state,
luabind::object &  table 
)
virtual

Old state load into/from global table.

virtual void DtLuaScriptInterfaceImpl::putObjectsFromGlobalTableIntoTable ( lua_State *  state,
luabind::object &  table 
)
virtual
virtual luabind::object DtLuaScriptInterfaceImpl::luaGetSubordinateFunctionNames ( )
virtual

Returns a a table of subordinate function handles and display text, e.g. { HANDLE1 = "First Function" }.

virtual luabind::object DtLuaScriptInterfaceImpl::luaGetParameterSubordinateFunctionsFromType ( const std::string  typeString)
virtual

Returns a table in the form {{<ENTITY-TYPE>,<FUNCTION-HANDLE>}}.

virtual void DtLuaScriptInterfaceImpl::connectForCallbacks ( )
virtual
virtual void DtLuaScriptInterfaceImpl::processEvents ( )
virtual
boost::shared_ptr<DtLuaAsyncJob> DtLuaScriptInterfaceImpl::luaGetWeaponSystemsInfo ( DtScriptVrfObject object)

Queries weapon system information for the specified entity or unit.

virtual bool DtLuaScriptInterfaceImpl::callLuaNoArgFunction ( const std::string &  functionName,
bool functionExists = 0 
)
protectedvirtual

If the function does not exist will return true if functionExists is suppled, else returns false. In the case of functionExists being supplied, check the return value of that to see if a true return from this method is still invalid due to a function not existing.

virtual void DtLuaScriptInterfaceImpl::updateFuncCallCount ( )
protectedvirtual

Member Data Documentation

lua_State* DtLuaScriptInterfaceImpl::myLState
protected
unsigned DtLuaScriptInterfaceImpl::myFuncCallCount
protected
bool DtLuaScriptInterfaceImpl::myLuaScriptWarningShown
protected
LocalInterfaceExtensions DtLuaScriptInterfaceImpl::myInterfaceExtensions
protected
GlobalInterfaceExtensions DtLuaScriptInterfaceImpl::theLuaInterfaceExtensions
staticprotected
luabind::object* DtLuaScriptInterfaceImpl::myCheckpointStateTable
protected
ReaderWriterToLuaTableMap DtLuaScriptInterfaceImpl::theReaderWriterToLuaTableMap
staticprotected
DtLuaMessageInterface* DtLuaScriptInterfaceImpl::myMessageInterface
protected
boost::signals2::scoped_connection DtLuaScriptInterfaceImpl::myInfluenceEventConnection
protected
std::vector<DtVrfObjectMessage*> DtLuaScriptInterfaceImpl::myTextReportCallbacks
protected
std::vector<makVrfEvents::DtEvent*> DtLuaScriptInterfaceImpl::myInfluenceEvents
protected

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

Document ID: Generated on Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)