vrforces5.1.1/classref/lua_script_interface_impl_8h_source.html

 /*******************************************************************************

 ** Copyright (c) 2020 MAK Technologies, Inc.

 ** All rights reserved.

 *******************************************************************************/

 #pragma once


 #include <vrfLua/vrfLuaDefines.h>

 #include <vrfLua/luaFeatureSet.h>

 #include <vrfLua/luaPathJob.h>


 #include "vrfobjcore/scriptInterface.h"

 #include "vrfobjcore/translatableStream.h"

 #include "vrfutil/scriptGeometry.h"

 #include "vrfobjcore/scriptVrfObject.h"

 #include <luabind/luabind.hpp>

 #include <vrfobjcore/luaScriptInterfaceExtension.h>

 #include <vrfExtObjects/influenceInteractionHLA.h>

 #include <vrfutil/objectCounter.h>


 #include <lua.hpp>

 #include <lauxlib.h>

 #include <lualib.h>


 #include <boost/signals2.hpp>


 namespace makVrfEvents

 {

    class DtEvent;

    class DtInfluenceEvent;

 }


 class DtLuaMessageInterface;

 class DtScriptWeaponInfo;


 typedef luabind::object (*ReaderWriterToLuaTableFcn)(lua_State* LS, const DtReaderWriter* rwString,

    const DtSimulationServices* mgr, const DtString& parameterType);


 const char ContactObservedOnly[] = "observedOnly";

 const char ContactAliveOnly[] = "aliveOnly";

 const char ContactHostileOnly[] = "hostileOnly";

 const char ContactCurrentlyDetectedOnly[] = "currentlyDetectedOnly";


 class DT_DLL_vrfLua DtLuaScriptInterfaceImpl

    : public DtScriptInterface

 #ifdef DtObjectDebugger_Enable

    , public DtObjectDebugger<DtLuaScriptInterfaceImpl>

 #endif

 {

 protected:

    DtLuaScriptInterfaceImpl(DtSimulationServices*);


    DtLuaScriptInterfaceImpl(const DtLuaScriptInterfaceImpl& other);

    DtLuaScriptInterfaceImpl& operator=(const DtLuaScriptInterfaceImpl& other);


 public:

    virtual ~DtLuaScriptInterfaceImpl();


    static DtScriptInterface* creator(DtSimulationServices*);


    virtual void init() override;


    virtual DtString type() const override;


    virtual bool invokeInit() override;

    virtual void invokeSuspend() override;

    virtual bool invokeResume() override;

    virtual void invokeTick() override;

    virtual bool invokeCheck() override;

    virtual void invokeCheckInit() override;

    virtual void invokeShutdown() override;

    virtual void invokeUpdateDisplayGraph() override;


    virtual void invokeDisable() override;


    virtual bool loadScript(bool reload) override;


    virtual void setLuaState(lua_State* L);

    virtual lua_State* getLuaState();


    virtual std::string dumpLuaStack() const;

    virtual int luaStackSize() const;

    virtual void collectGarbage();


    virtual DtReaderWriter* saveState() override;

    virtual bool loadState(const DtReaderWriter* loadState) override;

    virtual void processClearForReuse() override;


    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);


    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);

    static luabind::object createLuaTableFromRwRegistry(lua_State* L, const DtReaderWriterRegistry& rwRegistry, DtSimulationServices* simServices);


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


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


    void luaEndTask(bool success);

    void luaEndSet();


    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();


    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 luaSendTaskNotAsSubtask(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();


    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);


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


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


    boost::shared_ptr<DtLuaAsyncJob> findCoverPoint(

       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<DtLuaAsyncJob> findPathToLocation(

       const DtLocation3D& startLocation, const DtLocation3D& destinationLocation,

       bool useAbstractGraphs, const DtLocation3D& avoidLocation, double avoidanceRadius);


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


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


    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);


    /*

    job = vrf:luaFindSinglePosition(taskParameters.targetArea:getLocations3D(),

       taskParameters.battlePosition,

       targetHeightMeters, -- 2/3 vehicle height, for example.

       double viewHeightMeters, -- 2/3 vehicle height, for example.

       double hideHeightMeters, -- 1.1x vehicle height, for example.

       double forwardBackSearchLimitMeters, -- 50m forward + 50m backward = 100m

       double forwardBackSearchIntervalMeters, -- half vehicle length, for example.

      double maxSlopeDegrees, -- *todo add comments*

       )

    )


    */

    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);


    /*

    job = vrf:luaFindSinglePosition(taskParameters.targetArea:getLocations3D(),

       taskParameters.battlePosition,

       targetHeightMeters, -- 2/3 vehicle height, for example.

       double viewHeightMeters, -- 2/3 vehicle height, for example.

       double hideHeightMeters, -- 1.1x vehicle height, for example.

       double forwardBackSearchLimitMeters, -- 50m forward + 50m backward = 100m

       double forwardBackSearchIntervalMeters, -- half vehicle length, for example.

      double maxSlopeDegrees, -- *todo add comments*

       bool bDebug -- Log additional information)

    )

    */

    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);


    /*

    job = vrf:findVehicleFightingPositions(taskParameters.numberOfPoints,

    taskParameters.targetArea:getLocations3D(),

    taskParameters.battlePosition,

    maxVolume, -- half dimensions of hide position

    maxVolume:getUp() * 0.67, --67% of total height for shooting height

    maxVolume:getUp() * 0.50, -- half height for target height

    searchWidthForward, -- how much forward and back to search forward and back

    searchWidthSide -- how much side to side to search

    positionSpacing -- how many meters between positions, side to side

    )

    */

    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<DtLuaAsyncJob> getAllEmbarkationSlots(DtScriptVrfObject& object);


    boost::shared_ptr<DtLuaAsyncJob> getEmbarkationSlots(DtScriptVrfObject& object);


    boost::shared_ptr<DtLuaAsyncJob> getEmbarkationSlotsFiltered(DtScriptVrfObject& object,

       bool bAllSlots);


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


    boost::shared_ptr<DtLuaAsyncJob> getEmbarkationEgressPoints(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);


    static void textReportCallback(const DtVrfObjectMessage* m, void* usr);

    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);


    static void addReaderWriterToLuaTableFunction(const DtString&, ReaderWriterToLuaTableFcn);


    static void influenceEventCallback(DtBoost::shared_ptr<const makVrfEvents::DtInfluenceEvent> event, void* usr);

    virtual void queueInfluence(DtBoost::shared_ptr<const makVrfEvents::DtInfluenceEvent> e);

    virtual void processInfluence(DtBoost::shared_ptr<const makVrfEvents::DtInfluenceEvent> e);


    virtual void processEntityDestroyed() override;


    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);


    std::vector<DtLocation3D> luaMakeOffsetPoints(

       luabind::object const& fromPoints,

       const DtVectorOffset3D& offset);

    std::vector<DtLocation3D> luaMakeOffsetPointsWithRadius(luabind::object const& fromPoints,

       const DtVectorOffset3D& offset, const double minimumTurnRadius);


    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);


    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);


    bool luaIntersectSegments2D(const DtLocation3D& p1, const DtLocation3D& p2,

       const DtLocation3D& p3, const DtLocation3D& p4,

       DtLocation3D& intersectPoint);


    virtual bool luaIsDatabaseLoggingEnabled();


    virtual void luaLogEventToDatabase(unsigned eventType, luabind::object const& parameters);


    class DtLuaScriptFunctionReference : public DtScriptFunctionReference

    {

    public:

       DtLuaScriptFunctionReference(const std::string& functionName)

       : DtScriptFunctionReference()

       , myFunctionName(functionName)

       {


       }


       virtual ~DtLuaScriptFunctionReference()

       {


       }


       std::string functionName() const

       {

          return myFunctionName;

       }


       virtual bool operator<(const DtScriptFunctionReference& other) const override

       {

          try

          {

             const DtLuaScriptFunctionReference& rhs =

                dynamic_cast<const DtLuaScriptFunctionReference&>(other);

             return myFunctionName.compare(rhs.myFunctionName) < 0;

          }

          catch(...)

          {

             DtInfo << "DtLuaScriptFunctionReference::operator< attempt to compare with wrong type.\n";

             return false;

          }

       }


    protected:

       std::string myFunctionName;

    };


    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) override;


    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<DtLuaAsyncJob> luaGetWeaponSystemsInfo(DtScriptVrfObject& object);


 protected:

    virtual bool callLuaNoArgFunction(const std::string& functionName, bool* functionExists = nullptr);


    virtual void updateFuncCallCount();


    lua_State* myLState;

    unsigned myFuncCallCount;

    bool myLuaScriptWarningShown;


    typedef std::vector<DtLuaScriptInterfaceExtension*> LocalInterfaceExtensions;

    LocalInterfaceExtensions myInterfaceExtensions;


    struct LuaExtension

    {

       LuaExtension() : creator(nullptr), onlyForEntity(nullptr), usr(nullptr) {};

       LuaExtension(const LuaExtension& orig) : creator(orig.creator), onlyForEntity(orig.onlyForEntity),

          usr(orig.usr) {};


       DtLuaScriptInterfaceExtension::CreatorFcn creator;

       const DtLocalObject* onlyForEntity;

       void* usr;

    };


    typedef std::vector<LuaExtension> GlobalInterfaceExtensions;


    static GlobalInterfaceExtensions theLuaInterfaceExtensions;


    luabind::object myCheckpointStateTable;


    typedef std::map<DtString, ReaderWriterToLuaTableFcn> ReaderWriterToLuaTableMap;

    static ReaderWriterToLuaTableMap theReaderWriterToLuaTableMap;

    DtLuaMessageInterface* myMessageInterface;


    std::vector<DtVrfObjectMessage*> myTextReportCallbacks;

    std::vector<DtBoost::shared_ptr<const makVrfEvents::DtInfluenceEvent> > myInfluenceEvents;


    bool myNeedsInvokeShutdown = true;

 };


 DT_DEFINE_OBJECT_DEBUGGER_NAME(DtLuaScriptInterfaceImpl);


 namespace luaScriptInterface

 {

    typedef luabind::object (*rwToLuaBindObjectFcn)(

       const DtReaderWriter* rw, lua_State* L);


    luabind::object luaGetEntityParam(lua_State* L,

       const DtScriptVrfObject& entity, std::string const& paramName);


    luabind::object luaGetSystemAttribute(

       const DtScriptComponentSystem& system, const std::string& attributeName

       , bool *error

       , lua_State *L

       );


    luabind::object luaGetContactInfo(lua_State* L, const DtScriptOwnshipObject& thisEntity,

       const DtScriptVrfObject& otherEntity);


    luabind::object luaGetSubordinateFormation(lua_State* L,

       const DtScriptOwnshipObject& entity,

       DtScriptVrfObject& leadSubordinate);


    std::list<DtVectorOffset3D> luaGetOptionFormationPositions(lua_State* L,

       const DtScriptVrfObject& unit,

       const std::string& formationName, luabind::object const& options,

       int* leaderIndex);


    std::list<DtVectorOffset3D> luaGetFormationPositions(lua_State* L,

       const DtScriptVrfObject& unit,

       const std::string& formationName,

       int* leaderIndex);


    luabind::object luaGetParameterSubordinateFunctions(lua_State* L, const DtScriptVrfObject& entity);


    luabind::object luaGetSubordinateFunctions(lua_State* L, const DtScriptVrfObject& entity);


    bool luaSetSubordinateFunctions(lua_State* L, const DtScriptVrfObject& entity, luabind::object const& subsAndFunctions);


    std::string luaGetSubordinateFunction(lua_State* L, const DtScriptVrfObject& entity, const DtScriptVrfObject& subEntity);


    bool luaSetSubordinateFunction(lua_State* L, const DtScriptVrfObject& entity, const DtScriptVrfObject& subEntity, const std::string& subFunction);


    luabind::object luaGetAisData(lua_State* L, const DtScriptVrfObject& entity);


    luabind::object luaGetTargetPriorityList(lua_State* L, const DtScriptOwnshipObject& thisEntity);


    std::list<DtScriptVrfObject> luaGetContactsWithFilter(

       lua_State* L, const DtScriptOwnshipObject& entity,

       luabind::object const& typeFilters, bool observedOnly);

    std::list<DtScriptVrfObject> luaGetContactsWithFilterAliveOnly(

       lua_State* L, const DtScriptOwnshipObject& entity,

       luabind::object const& typeFilters, bool observedOnly,

       bool aliveOnly);


    std::list<DtScriptVrfObject> luaGetHostileContactsWithFilterAliveOnly(

       lua_State* L, const DtScriptOwnshipObject& entity,

       luabind::object const& typeFilters, bool observedOnly,

       bool aliveOnly);


    std::list<DtScriptVrfObject> luaGetContacts(

       lua_State* L, const DtScriptOwnshipObject& entity,

       luabind::object const& typeFilters,

       luabind::object const& flags);


    luabind::object luaGetWeaponInfoList(lua_State* L, const DtScriptOwnshipObject& thisEntity);


    luabind::object luaGetWeaponInfo(lua_State* L, const DtScriptOwnshipObject& thisEntity, const std::string& weaponId);


    bool luaWeaponCanTargetLocation(lua_State* L, const DtScriptOwnshipObject& thisEntity,

       const std::string& weaponId, const DtLocation3D& location);


    std::string luaWeaponTargetApplicability(lua_State* L, const DtScriptOwnshipObject& thisEntity,

       const std::string& weaponId, const std::string& targetType);


    luabind::object luaGetWeaponFireTask(lua_State* L, const DtScriptOwnshipObject& thisEntity,

       const std::string& weaponId, luabind::object const& locationRef);


    bool luaSetStateProperty(lua_State* L, DtScriptOwnshipObject& entity,

       const std::string& propertyName, luabind::object const& prop);


    bool luaSetOrAddStateProperty(lua_State* L, DtScriptOwnshipObject& entity,

       const std::string& propertyName, luabind::object const& prop, bool addIfNotFound);


    bool luaSetStatePropertyListItem(lua_State* L,

       DtScriptOwnshipObject& entity, const std::string& propertyName,

       luabind::object const& keyValues, luabind::object const& itemValue);


    bool luaSetStatePropertyListItemByIndex(

       lua_State* L, DtScriptOwnshipObject& entity, const std::string& propertyName,

       int index, luabind::object const& itemValue);


    bool luaSetStatePropertyMapItem(lua_State* L,

       DtScriptOwnshipObject& entity, const std::string& propertyName,

       luabind::object const& keyValue, luabind::object const& itemValue);


    luabind::object luaGetStateProperty(lua_State* L,

       const DtScriptVrfObject& entity, const std::string& propertyName);

    luabind::object luaGetStateOwnshipProperty(lua_State* L,

       const DtScriptOwnshipObject& entity, const std::string& propertyName);


    luabind::object luaGetStatePropertyListItem(lua_State* L,

       const DtScriptVrfObject& entity, const std::string& propertyName,

       luabind::object const& keyValues, int& index);

    luabind::object luaGetStateOwnshipPropertyListItem(lua_State* L,

       const DtScriptOwnshipObject& entity, const std::string& propertyName,

       luabind::object const& keyValues, int& index);


    luabind::object luaGetStatePropertyListItemByIndex(lua_State* L,

       const DtScriptVrfObject& entity, const std::string& propertyName,

       int index);

    luabind::object luaGetStateOwnshipPropertyListItemByIndex(lua_State* L,

       const DtScriptOwnshipObject& entity, const std::string& propertyName,

       int index);


    luabind::object luaGetStatePropertyMapItem(lua_State* L,

       const DtScriptVrfObject& entity, const std::string& propertyName,

       luabind::object const& keyValue);

    luabind::object luaGetStateOwnshipPropertyMapItem(lua_State* L,

       const DtScriptOwnshipObject& entity, const std::string& propertyName,

       luabind::object const& keyValue);


    luabind::object luaGetParamProperty(lua_State* L,

       const DtScriptVrfObject& entity, std::string const& paramName);

    luabind::object luaGetOwnshipParamProperty(lua_State* L,

       const DtScriptOwnshipObject& entity, std::string const& paramName);


    luabind::object luaGetParameterPropertyListItem(lua_State* L,

       const DtScriptVrfObject& entity, const std::string& propertyName,

       luabind::object const& keyValues, int& index);

    luabind::object luaGetOwnshipParameterPropertyListItem(lua_State* L,

       const DtScriptOwnshipObject& entity, const std::string& propertyName,

       luabind::object const& keyValues, int& index);


    luabind::object luaGetParameterPropertyListItemByIndex(lua_State* L,

       const DtScriptVrfObject& entity, const std::string& propertyName,

       int index);

    luabind::object luaGetOwnshipParameterPropertyListItemByIndex(lua_State* L,

       const DtScriptOwnshipObject& entity, const std::string& propertyName,

       int index);


    luabind::object luaGetParameterPropertyMapItem(lua_State* L,

       const DtScriptVrfObject& entity, const std::string& propertyName,

       luabind::object const& keyValue);

    luabind::object luaGetOwnshipParameterPropertyMapItem(lua_State* L,

       const DtScriptOwnshipObject& entity, const std::string& propertyName,

       luabind::object const& keyValue);


    bool luaSetSystemAttribute(

       DtScriptComponentSystem& system, const std::string& attributeName,

       const luabind::object & value,

       lua_State *L);


    static const std::map<DtString, rwToLuaBindObjectFcn>& rwToLuaBindObjectMap();

 };

DtScriptInterface::invokePostSetDataCallback
virtual void invokePostSetDataCallback(DtScriptFunctionReferencePtr functionReference, DtSetDataRequestMessage *setDatRequest)=0
Implement to invoke the function referenced by functionReference. setDatRequest contains the informat...

DtScriptInterface::processEntityDestroyed
virtual void processEntityDestroyed()
Can be overridden to perform some processing when the entity is destroyed.
Definition: scriptInterface.h:200

DtLuaScriptInterfaceImpl::myTextReportCallbacks
std::vector< DtVrfObjectMessage * > myTextReportCallbacks
Definition: luaScriptInterfaceImpl.h:766

DtLuaScriptInterfaceImpl::DtLuaScriptFunctionReference::operator<
virtual bool operator<(const DtScriptFunctionReference &other) const override
Required for std::set.
Definition: luaScriptInterfaceImpl.h:671

DtScriptInterface::addPostSetDataCallback
virtual void addPostSetDataCallback(const DtSetMessageType &setDataType, DtScriptFunctionReferencePtr functionReference)
Adds a callback to be invoked after the specified type of set data request is executed.

DtScriptInterface::invokeInit
virtual bool invokeInit()=0

luaScriptInterface::luaGetParameterPropertyListItemByIndex
luabind::object luaGetParameterPropertyListItemByIndex(lua_State *L, const DtScriptVrfObject &entity, const std::string &propertyName, int index)
Returns an object containing the value of the of an item in the given parameter property. The property must be a list. Returns the item at the given index, using the Lua convention that the first item is at index 1. The result may be a table containing a number of fields that make up the item, or a single value, depending on the data type of the list items. If the property or list item could not be found, the returned table will be empty.

luaScriptInterface::luaGetContactsWithFilterAliveOnly
std::list< DtScriptVrfObject > luaGetContactsWithFilterAliveOnly(lua_State *L, const DtScriptOwnshipObject &entity, luabind::object const &typeFilters, bool observedOnly, bool aliveOnly)
Same as luaGetContactsWithFiler but adds a boolean flag to indicate that only non-destroyed entities ...

DtScriptWeaponInfo
This class is a wrapper for a DtCompSystem for use by scripts. It derives from DtAsciiSerializable so...
Definition: scriptWeaponInfo.h:22

luaScriptInterface::luaGetParamProperty
luabind::object luaGetParamProperty(lua_State *L, const DtScriptVrfObject &entity, std::string const &paramName)
Returns an object containing the value of the requested parameter property. May be a table containing...

ContactObservedOnly
const char ContactObservedOnly[]
Definition: luaScriptInterfaceImpl.h:42

luaScriptInterface::luaGetSubordinateFunctions
luabind::object luaGetSubordinateFunctions(lua_State *L, const DtScriptVrfObject &entity)
Return a table of {{&quot;subordinate&quot; = DtScriptVrfObject, &quot;function&quot; = string}}.

DtLuaScriptInterfaceImpl::theLuaInterfaceExtensions
static GlobalInterfaceExtensions theLuaInterfaceExtensions
Definition: luaScriptInterfaceImpl.h:758

DtLuaScriptInterfaceImpl::GlobalInterfaceExtensions
std::vector< LuaExtension > GlobalInterfaceExtensions
Definition: luaScriptInterfaceImpl.h:756

DtLuaScriptInterfaceImpl::myLState
lua_State * myLState
Definition: luaScriptInterfaceImpl.h:738

DtScriptInterface::invokeResume
virtual bool invokeResume()=0

objectCounter.h

luaScriptInterface::luaGetStateOwnshipPropertyListItemByIndex
luabind::object luaGetStateOwnshipPropertyListItemByIndex(lua_State *L, const DtScriptOwnshipObject &entity, const std::string &propertyName, int index)

DtScriptInterface::loadState
virtual bool loadState(const DtReaderWriter *savedState)=0
Called when the scenario is loaded. The load state pointer may not be valid, which does not indicate ...

luaScriptInterface::luaSetSubordinateFunctions
bool luaSetSubordinateFunctions(lua_State *L, const DtScriptVrfObject &entity, luabind::object const &subsAndFunctions)
Given a table of {{&quot;subordinate&quot; = DtScriptVrfObject, &quot;function&quot; = string}} Set the state propert...

luaScriptInterface::luaGetStateOwnshipPropertyMapItem
luabind::object luaGetStateOwnshipPropertyMapItem(lua_State *L, const DtScriptOwnshipObject &entity, const std::string &propertyName, luabind::object const &keyValue)

DtLuaScriptInterfaceImpl::myFuncCallCount
unsigned myFuncCallCount
Definition: luaScriptInterfaceImpl.h:739

luaScriptInterface::luaGetSubordinateFormation
luabind::object luaGetSubordinateFormation(lua_State *L, const DtScriptOwnshipObject &entity, DtScriptVrfObject &leadSubordinate)
Gets a table indexed by simObject (subordinates) of position offset relative to the formation leader...

DtScriptInterface::invokeCheckInit
virtual void invokeCheckInit()=0

luaScriptInterface::luaGetParameterPropertyListItem
luabind::object luaGetParameterPropertyListItem(lua_State *L, const DtScriptVrfObject &entity, const std::string &propertyName, luabind::object const &keyValues, int &index)
Returns an object containing the value of the of an item in the given parameter property. The property must be a list. The item returned will have values matching the specified key values in the key fields. The result may be a table containing a number of fields that make up the item, or a single value, depending on the data type of the list items. If the property or list item could not be found, the returned table will be empty. Sets index to be the index of the item, using the Lua convention that the first item is at index 1.

DtReaderWriter
Definition: readerWriter.h:85

DT_DEFINE_OBJECT_DEBUGGER_NAME
#define DT_DEFINE_OBJECT_DEBUGGER_NAME(type)
Definition: objectCounter.h:31

DtObjectDebugger
Default on in debug, off in release.
Definition: objectCounter.h:27

ReaderWriterToLuaTableFcn
luabind::object(* ReaderWriterToLuaTableFcn)(lua_State *LS, const DtReaderWriter *rwString, const DtSimulationServices *mgr, const DtString &parameterType)
When adding decoder functions to turn reader/writer into lua tables, the format must be of the follow...
Definition: luaScriptInterfaceImpl.h:39

luaScriptInterface::luaSetStatePropertyListItemByIndex
bool luaSetStatePropertyListItemByIndex(lua_State *L, DtScriptOwnshipObject &entity, const std::string &propertyName, int index, luabind::object const &itemValue)
Finds the item in the list at the specified index and updates it to the new value. If the list is not long enough, new entries are added. Any items added in this way will be given the same value as the new entry. If the property does not exist or the format of the data is incorrect, returns false.

DtScriptInterface::removePostSetDataCallback
virtual void removePostSetDataCallback(const DtSetMessageType &setDataType, DtScriptFunctionReferencePtr functionReference)
Remove a callback invoked after the specified type of set data request is executed.

DtReaderWriterRegistry
Definition: readerWriterRegistry.h:39

DtScriptInterface::saveState
virtual DtReaderWriter * saveState()=0
Called when the scenario is saved. The stateState pointer may not be valid, in which case something w...

luaScriptInterface::luaGetStatePropertyListItemByIndex
luabind::object luaGetStatePropertyListItemByIndex(lua_State *L, const DtScriptVrfObject &entity, const std::string &propertyName, int index)
Returns an object containing the value of the of an item in the given state property. The state property must be a list. Returns the item at the given index, using the Lua convention that the first item is at index 1. The result may be a table containing a number of fields that make up the item, or a single value, depending on the data type of the list items. If the property or list item could not be found, the returned table will be empty.

DtLuaScriptInterfaceImpl::myInterfaceExtensions
LocalInterfaceExtensions myInterfaceExtensions
Definition: luaScriptInterfaceImpl.h:743

DtScriptInterface::loadScript
virtual bool loadScript(bool reload=false)=0
This will be called by the parent to let the interface know when to load the script.

DtLuaScriptInterfaceImpl::myLuaScriptWarningShown
bool myLuaScriptWarningShown
Definition: luaScriptInterfaceImpl.h:740

DtLuaScriptInterfaceImpl::theReaderWriterToLuaTableMap
static ReaderWriterToLuaTableMap theReaderWriterToLuaTableMap
Definition: luaScriptInterfaceImpl.h:763

luaScriptInterface::luaGetParameterSubordinateFunctions
luabind::object luaGetParameterSubordinateFunctions(lua_State *L, const DtScriptVrfObject &entity)
Gets a table of entity type and subordinate function handle pairs {{ENTITY_TYPE_STRING, FUNCTION_HANDLE_STRING}}.

luaScriptInterface::luaGetWeaponInfo
luabind::object luaGetWeaponInfo(lua_State *L, const DtScriptOwnshipObject &thisEntity, const std::string &weaponId)

luaScriptInterface::luaGetWeaponFireTask
luabind::object luaGetWeaponFireTask(lua_State *L, const DtScriptOwnshipObject &thisEntity, const std::string &weaponId, luabind::object const &locationRef)

luaScriptInterface::luaGetContactsWithFilter
std::list< DtScriptVrfObject > luaGetContactsWithFilter(lua_State *L, const DtScriptOwnshipObject &entity, luabind::object const &typeFilters, bool observedOnly)
This function supports the script API. It gets the list of contacts matching the given filter and ret...

DtLuaScriptInterfaceImpl::DtLuaScriptFunctionReference::functionName
std::string functionName() const
Definition: luaScriptInterfaceImpl.h:666

DtLuaScriptInterfaceImpl::DtLuaScriptFunctionReference::DtLuaScriptFunctionReference
DtLuaScriptFunctionReference(const std::string &functionName)
Definition: luaScriptInterfaceImpl.h:654

luaScriptInterface::luaGetStatePropertyMapItem
luabind::object luaGetStatePropertyMapItem(lua_State *L, const DtScriptVrfObject &entity, const std::string &propertyName, luabind::object const &keyValue)
Returns an object containing the value of the of an item in the given state property. The state property must be a map. The item returned will have values matching the specified key value. The result may be a table containing a number of fields that make up the item, or a single value, depending on the data type of the list items. If the property or map item could not be found, the returned table will be empty.

DtVectorOffset3D
VectorOffset3D is a direction vector that is relative to some direction specified by a Vector3D...
Definition: scriptGeometry.h:424

DtLuaMessageInterface
Handles translation of messages from C++ structures into Lua tables and the reverse translation as we...
Definition: luaMessageInterface.h:23

vrfLuaDefines.h

luaScriptInterface::luaGetOwnshipParamProperty
luabind::object luaGetOwnshipParamProperty(lua_State *L, const DtScriptOwnshipObject &entity, std::string const &paramName)

luaScriptInterface::luaGetSubordinateFunction
std::string luaGetSubordinateFunction(lua_State *L, const DtScriptVrfObject &entity, const DtScriptVrfObject &subEntity)
Return a string representing subordinate function for indicated subordinate.

DtLuaScriptInterfaceImpl::LuaExtension::LuaExtension
LuaExtension(const LuaExtension &orig)
Definition: luaScriptInterfaceImpl.h:748

luaScriptInterface::luaSetStatePropertyMapItem
bool luaSetStatePropertyMapItem(lua_State *L, DtScriptOwnshipObject &entity, const std::string &propertyName, luabind::object const &keyValue, luabind::object const &itemValue)
Sets a single item in a map state property to the given value. First looks in the map to see if any e...

DtScriptInterface::type
virtual DtString type() const =0
Script engine type.

makVrv::vrvTacticalGraphicUtilities::distance
DT_DLL_VRVCORE double distance(const makVrv::DtCoordinateSystem &, const DtVector &from, const DtVector &to)
Returns the distance from the two points. Coordinates are in local database coordinates The coordinat...

DtLuaFeatureGeometry
Represents a feature geometry.
Definition: luaFeatureGeometry.h:25

luaScriptInterface::luaGetStateOwnshipPropertyListItem
luabind::object luaGetStateOwnshipPropertyListItem(lua_State *L, const DtScriptOwnshipObject &entity, const std::string &propertyName, luabind::object const &keyValues, int &index)

luaScriptInterface::rwToLuaBindObjectMap
static const std::map< DtString, rwToLuaBindObjectFcn > & rwToLuaBindObjectMap()

DtLuaScriptInterfaceImpl::LuaExtension::onlyForEntity
const DtLocalObject * onlyForEntity
Definition: luaScriptInterfaceImpl.h:752

DtLuaScriptInterfaceImpl
Definition: luaScriptInterfaceImpl.h:50

luaScriptInterface::luaGetOwnshipParameterPropertyListItem
luabind::object luaGetOwnshipParameterPropertyListItem(lua_State *L, const DtScriptOwnshipObject &entity, const std::string &propertyName, luabind::object const &keyValues, int &index)

luaScriptInterface::luaSetStateProperty
bool luaSetStateProperty(lua_State *L, DtScriptOwnshipObject &entity, const std::string &propertyName, luabind::object const &prop)
Sets the specified state property with the given value. If the property does not exist or the format ...

luaScriptInterface::luaGetSystemAttribute
luabind::object luaGetSystemAttribute(const DtScriptComponentSystem &system, const std::string &attributeName, bool *error, lua_State *L)

scriptInterface.h

luaScriptInterface::rwToLuaBindObjectFcn
luabind::object(* rwToLuaBindObjectFcn)(const DtReaderWriter *rw, lua_State *L)
Definition: luaScriptInterfaceImpl.h:783

DtScriptInterface::invokeDisable
virtual void invokeDisable()=0
Only called for reactive tasks which can be enabled but not active. When the task is completely disab...

DtLuaScriptInterfaceImpl::myInfluenceEvents
std::vector< DtBoost::shared_ptr< const makVrfEvents::DtInfluenceEvent > > myInfluenceEvents
Definition: luaScriptInterfaceImpl.h:767

DtScriptInterface::invokeTick
virtual void invokeTick()=0
This will be called by the parent to invoke the script tick.

luaFeatureSet.h

luaScriptInterface::luaGetFormationPositions
std::list< DtVectorOffset3D > luaGetFormationPositions(lua_State *L, const DtScriptVrfObject &unit, const std::string &formationName, int *leaderIndex)
Calls luaGetOptionFormationPositions with empty options.

DT_DLL_vrfLua
#define DT_DLL_vrfLua
This file is used to determine how to build.
Definition: vrfLuaDefines.h:25

luaScriptInterface::luaSetStatePropertyListItem
bool luaSetStatePropertyListItem(lua_State *L, DtScriptOwnshipObject &entity, const std::string &propertyName, luabind::object const &keyValues, luabind::object const &itemValue)
Sets a single item in a list state property to the given value. First looks in the list to see if any...

luaScriptInterface::luaWeaponTargetApplicability
std::string luaWeaponTargetApplicability(lua_State *L, const DtScriptOwnshipObject &thisEntity, const std::string &weaponId, const std::string &targetType)
lua &quot;weaponTargetApplicability()&quot;

ContactAliveOnly
const char ContactAliveOnly[]
Definition: luaScriptInterfaceImpl.h:43

DtScriptInterface::DtScriptFunctionReferencePtr
boost::shared_ptr< DtScriptFunctionReference > DtScriptFunctionReferencePtr
Shared ptr to DtScriptFunctionReference.
Definition: scriptInterface.h:54

luaScriptInterface::luaGetStatePropertyListItem
luabind::object luaGetStatePropertyListItem(lua_State *L, const DtScriptVrfObject &entity, const std::string &propertyName, luabind::object const &keyValues, int &index)
Returns an object containing the value of the of an item in the given state property. The state property must be a list. The item returned will have values matching the specified key values in the key fields. The result may be a table containing a number of fields that make up the item, or a single value, depending on the data type of the list items. If the property or list item could not be found, the returned table will be empty. Sets index to be the index of the item, using the Lua convention that the first item is at index 1.

DtTranslatableStream
This stream is used by the scripting classes to be able to send out translatable messages from script...
Definition: translatableStream.h:22

luaScriptInterface::luaGetContactInfo
luabind::object luaGetContactInfo(lua_State *L, const DtScriptOwnshipObject &thisEntity, const DtScriptVrfObject &otherEntity)
Gets the perceived contact info that this entity has for another entity.

DtVrfObjectMessage
The base class for all messages to/from a specific DtVrfObject. Various subclasses of this class will...
Definition: vrfObjectMessage.h:30

DtLuaScriptInterfaceImpl::DtLuaScriptFunctionReference
Override of DtScriptInterface::DtScriptFunctionReference that holds a function reference by function ...
Definition: luaScriptInterfaceImpl.h:651

DtLuaScriptInterfaceImpl::LocalInterfaceExtensions
std::vector< DtLuaScriptInterfaceExtension * > LocalInterfaceExtensions
Definition: luaScriptInterfaceImpl.h:742

DtScriptInterface::DtScriptFunctionReference
Abstract object used to hold a reference to a function defined in the script language, to be used later to invoke that function. Used for registering callbacks to be invoked after specified types of set data requests are executed. For this functionality to be used in a derived script interface implementation, a derived class must be implemented to represent a reference to a function in the script language.
Definition: scriptInterface.h:43

luaScriptInterface::luaGetEntityParam
luabind::object luaGetEntityParam(lua_State *L, const DtScriptVrfObject &entity, std::string const &paramName)

luaScriptInterface::luaGetStateProperty
luabind::object luaGetStateProperty(lua_State *L, const DtScriptVrfObject &entity, const std::string &propertyName)
Returns an object containing the value of the requested state property. May be a table containing a n...

DtScriptInterface::processClearForReuse
virtual void processClearForReuse()
This function should be overridden by the inheritor to clear out any task specific variables...

error
Definition: asyncJobServer.h:39

luaScriptInterface::luaSetSubordinateFunction
bool luaSetSubordinateFunction(lua_State *L, const DtScriptVrfObject &entity, const DtScriptVrfObject &subEntity, const std::string &subFunction)
Given a table of {{&quot;subordinate&quot; = DtScriptVrfObject, &quot;function&quot; = string}} Set the state propert...

translatableStream.h
Contains the DtTranslatableStream class declaration.

ContactCurrentlyDetectedOnly
const char ContactCurrentlyDetectedOnly[]
Definition: luaScriptInterfaceImpl.h:45

DtLuaScriptInterfaceExtension::CreatorFcn
DtLuaScriptInterfaceExtension *(* CreatorFcn)(void *usr)
Prototype for DtLuaScriptInterfaceExtension creator function.
Definition: luaScriptInterfaceExtension.h:37

DtSimulationServices
Central access point of all non-object-specific the services and managers that are available for use ...
Definition: simulationServices.h:95

luaScriptInterface::luaGetOwnshipParameterPropertyMapItem
luabind::object luaGetOwnshipParameterPropertyMapItem(lua_State *L, const DtScriptOwnshipObject &entity, const std::string &propertyName, luabind::object const &keyValue)

DtScriptInterface::operator=
DtScriptInterface & operator=(const DtScriptInterface &other)

DtScriptInterface::invokeCheck
virtual bool invokeCheck()=0

DtLuaFeatureSet
The DtLuaFeatureSet class is a wrapper around a DtFeatureSet that will provide feature information fo...
Definition: luaFeatureSet.h:28

luaScriptInterface::luaGetAisData
luabind::object luaGetAisData(lua_State *L, const DtScriptVrfObject &entity)
Returns a table of AIS data for the specified entity.

DtLuaScriptInterfaceImpl::LuaExtension::LuaExtension
LuaExtension()
Definition: luaScriptInterfaceImpl.h:747

DtLuaScriptInterfaceImpl::ReaderWriterToLuaTableMap
std::map< DtString, ReaderWriterToLuaTableFcn > ReaderWriterToLuaTableMap
Definition: luaScriptInterfaceImpl.h:762

luaScriptInterfaceExtension.h
DtLuaScriptInterfaceExtension.

init
DT_DLL_DEBUGDRAWRENDERER void init(makVrv::DtDe &de)
Work function for the plugin initialization.

DtLuaScriptInterfaceImpl::myCheckpointStateTable
luabind::object myCheckpointStateTable
Definition: luaScriptInterfaceImpl.h:760

luaScriptInterface::luaSetSystemAttribute
bool luaSetSystemAttribute(DtScriptComponentSystem &system, const std::string &attributeName, const luabind::object &value, lua_State *L)

influenceInteractionHLA.h
Contains Extended DI-Guy Object net types.

luaScriptInterface::luaGetTargetPriorityList
luabind::object luaGetTargetPriorityList(lua_State *L, const DtScriptOwnshipObject &thisEntity)
Gets the target priority list that this entity has.

DtLuaScriptInterfaceImpl::LuaExtension::usr
void * usr
Definition: luaScriptInterfaceImpl.h:753

ContactHostileOnly
const char ContactHostileOnly[]
Definition: luaScriptInterfaceImpl.h:44

DtLuaScriptInterfaceImpl::LuaExtension
Definition: luaScriptInterfaceImpl.h:745

DtScriptOwnshipObject
The &quot;this&quot; version is the own-ship object. It is separated to  allow special functions for the ownshi...
Definition: scriptVrfObject.h:405

luaPathJob.h

DtLuaScriptInterfaceImpl::myMessageInterface
DtLuaMessageInterface * myMessageInterface
Definition: luaScriptInterfaceImpl.h:764

luaScriptInterface::luaGetOptionFormationPositions
std::list< DtVectorOffset3D > luaGetOptionFormationPositions(lua_State *L, const DtScriptVrfObject &unit, const std::string &formationName, luabind::object const &options, int *leaderIndex)
Gets a list of offset vectors defining the positions in the formation. Returns the index of the leade...

luaScriptInterface::luaGetWeaponInfoList
luabind::object luaGetWeaponInfoList(lua_State *L, const DtScriptOwnshipObject &thisEntity)
Lua &quot;getWeaponInfo()&quot; Returns a list of the weapon info for weapons on this entity.

DtScriptComponentSystem
This class is a wrapper for a DtCompSystem for use by scripts. It derives from DtAsciiSerializable so...
Definition: scriptComponentSystem.h:18

DtScriptInterface
This class is a two-way interface between the script language and its parent controller. There are functions that either the parent controller will call on the script interface (such as tick() ) and there will be functions the script interface will call on the parent controller to inform the parent of status updates and for data access.
Definition: scriptInterface.h:32

DtLuaScriptInterfaceImpl::DtLuaScriptFunctionReference::myFunctionName
std::string myFunctionName
Definition: luaScriptInterfaceImpl.h:687

luaScriptInterface::luaWeaponCanTargetLocation
bool luaWeaponCanTargetLocation(lua_State *L, const DtScriptOwnshipObject &thisEntity, const std::string &weaponId, const DtLocation3D &location)
lua &quot;weaponCanTargetLocation()&quot;

luaScriptInterface::luaGetOwnshipParameterPropertyListItemByIndex
luabind::object luaGetOwnshipParameterPropertyListItemByIndex(lua_State *L, const DtScriptOwnshipObject &entity, const std::string &propertyName, int index)

DtString

DtScriptInterface::invokeSuspend
virtual void invokeSuspend()=0

offset
voidpf uLong offset
Definition: ioapi.h:42

char

scriptGeometry.h

DtSetDataRequestMessage
A DtSetDataRequestMessage is a DtRadioMsg with a pointer to a setDataRequest. The type of the DtSetDa...
Definition: setDataRequestMessage.h:29

scriptVrfObject.h

luaScriptInterface::luaGetStateOwnshipProperty
luabind::object luaGetStateOwnshipProperty(lua_State *L, const DtScriptOwnshipObject &entity, const std::string &propertyName)

luaScriptInterface::luaSetOrAddStateProperty
bool luaSetOrAddStateProperty(lua_State *L, DtScriptOwnshipObject &entity, const std::string &propertyName, luabind::object const &prop, bool addIfNotFound)
Sets the specified state property with the given value. If not found and addIfNotFound is true...

luaScriptInterface::luaGetContacts
std::list< DtScriptVrfObject > luaGetContacts(lua_State *L, const DtScriptOwnshipObject &entity, luabind::object const &typeFilters, luabind::object const &flags)
Lua &quot;getContacts()&quot; Return a list of contacts matching the given table of entity type filters...

luaScriptInterface::luaGetParameterPropertyMapItem
luabind::object luaGetParameterPropertyMapItem(lua_State *L, const DtScriptVrfObject &entity, const std::string &propertyName, luabind::object const &keyValue)
Returns an object containing the value of the of an item in the given parameter property. The property must be a map. The item returned will have values matching the specified key value. The result may be a table containing a number of fields that make up the item, or a single value, depending on the data type of the list items. If the property or map item could not be found, the returned table will be empty.

luaScriptInterface::luaGetHostileContactsWithFilterAliveOnly
std::list< DtScriptVrfObject > luaGetHostileContactsWithFilterAliveOnly(lua_State *L, const DtScriptOwnshipObject &entity, luabind::object const &typeFilters, bool observedOnly, bool aliveOnly)
This function is the same as luaGetContactsWithFilterAliveOnly, but it returns only hostile contacts...

DtScriptInterface::invokeShutdown
virtual void invokeShutdown()=0

DtScriptInterface::invokeUpdateDisplayGraph
virtual void invokeUpdateDisplayGraph()=0
Called when graphs are enabled to get an immediate graph output.

DtLuaScriptInterfaceImpl::DtLuaScriptFunctionReference::~DtLuaScriptFunctionReference
virtual ~DtLuaScriptFunctionReference()
Definition: luaScriptInterfaceImpl.h:661

DtLocalObject
A locally simulated VRF object. Holds all internal and external data for the object, and provides access to both the current frame and next frame state data for the object. All current frame data is read-only, and next-frame data can be written to. No thread safety guarantees are made on this object during the simulation frame and it should only be accessed by the thread that is simulating the object.
Definition: localObject.h:86

DtScriptVrfObject
Definition: scriptVrfObject.h:30

DtLocation3D
A location3D is a point in space, i.e. a geocentric coordinate.
Definition: scriptGeometry.h:22