vrforces4.10/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 <vrfExtendedProperties/influenceInteractionExtension.h>

 #include <vrfutil/objectCounter.h>

 #include <vrfcore/simManager.h>


 #include <lua.hpp>

 #include <lauxlib.h>

 #include <lualib.h>


 class DtLuaMessageInterface;


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

    DtVrfObjectManager* mgr, const DtString& parameterType);


 class DT_DLL_vrfLua DtLuaScriptInterfaceImpl

    : public DtScriptInterface

 #ifdef DtObjectDebugger_Enable

    , public DtObjectDebugger<DtLuaScriptInterfaceImpl>

 #endif

 {

 protected:

    DtLuaScriptInterfaceImpl();


    DtLuaScriptInterfaceImpl(const DtLuaScriptInterfaceImpl& other);

    DtLuaScriptInterfaceImpl& operator=(const DtLuaScriptInterfaceImpl& other);


 public:

    virtual ~DtLuaScriptInterfaceImpl();


    static DtScriptInterface* creator();


    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 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 DtReaderWriter* saveState();

    virtual bool loadState(const DtReaderWriter* loadState);

    virtual void processClearForReuse();


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


    static void addLuaScriptInterfaceExtension(DtLuaScriptInterfaceExtension::CreatorFcn extension,

       const DtVrfObject* onlyForEntity, void* usr);


    static void removeLuaScriptInterfaceExtension(DtLuaScriptInterfaceExtension::CreatorFcn extension, void* usr);


    static void removeLuaScriptInterfaceExtension(DtLuaScriptInterfaceExtension::CreatorFcn extension,

       const DtVrfObject* 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 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 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);


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


    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 luaDeleteObject(std::string const& receiver);

    void luaDeleteScriptObject(const DtScriptVrfObject& receiver);


    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 processTextReport(const DtVrfObjectMessage* m);


    void luaSendInfluence(const DtScriptVrfObject& target,

       const std::string& influenceName, luabind::object const& influenceParams);


    static void addReaderWriterToLuaTableFunction(const DtString&, ReaderWriterToLuaTableFcn);


 #ifdef DtHLA

    static void influenceCallback(DtInfluenceInteractionExtension* m, void* usr);

    virtual void processInfluence(DtInfluenceInteractionExtension* m);

 #endif


    virtual void processEntityDestroyed();


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


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


    virtual std::vector<DtLocation3D> luaMakeOffsetPoints(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);


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


    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

       {

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


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


 protected:

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


    virtual void updateFuncCallCount();


    lua_State* myLState;

    unsigned myFuncCallCount;

    bool myLuaScriptWarningShown;


    typedef std::vector<DtLuaScriptInterfaceExtension*> LocalInterfaceExtensions;

    LocalInterfaceExtensions myInterfaceExtensions;


    struct LuaExtension

    {

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

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

          usr(orig.usr) {};


       DtLuaScriptInterfaceExtension::CreatorFcn creator;

       const DtVrfObject* 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;

 };


 DT_DEFINE_OBJECT_DEBUGGER_NAME(DtLuaScriptInterfaceImpl);


 namespace luaScriptInterface

 {

    typedef luabind::object (*rwToLuaBindObjectFcn)(

       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 DtScriptVrfObject& thisEntity,

       const DtScriptVrfObject& otherEntity);


    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 luaGetTargetPriorityList(lua_State* L, const DtScriptVrfObject& thisEntity);


    std::list<DtScriptVrfObject> luaGetContactsWithFilter(

       lua_State* L, const DtScriptVrfObject& entity,

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

    std::list<DtScriptVrfObject> luaGetContactsWithFilterAliveOnly(

       lua_State* L, const DtScriptVrfObject& entity,

       luabind::object const& typeFilters, bool observedOnly,

       bool aliveOnly);


    std::list<DtScriptVrfObject> luaGetHostileContactsWithFilterAliveOnly(

       lua_State* L, const DtScriptVrfObject& entity,

       luabind::object const& typeFilters, bool observedOnly,

       bool aliveOnly);


    bool luaSetStateProperty(lua_State* L, const DtScriptVrfObject& entity,

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


    bool luaSetOrAddStateProperty(lua_State* L, const DtScriptVrfObject& entity,

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


    bool luaSetStatePropertyListItem(lua_State* L,

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

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


    bool luaSetStatePropertyListItemByIndex(

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

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


    bool luaSetStatePropertyMapItem(lua_State* L,

       const DtScriptVrfObject& 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 luaGetStatePropertyListItem(lua_State* L,

       const DtScriptVrfObject& 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 luaGetStatePropertyMapItem(lua_State* L,

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

       luabind::object const& keyValue);


    luabind::object luaGetParamProperty(lua_State* L,

       const DtScriptVrfObject& 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 luaGetParameterPropertyListItemByIndex(lua_State* L,

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

       int index);


    luabind::object luaGetParameterPropertyMapItem(lua_State* L,

       const DtScriptVrfObject& 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.

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

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

influenceInteractionExtension.h

DtVrfObject
DtVrfObject is used to represent any type of simulated object (entities, aggregate, control objects) in a VR-Forces application.
Definition: vrfObject.h:215

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.

simManager.h

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.

DtLuaScriptInterfaceImpl::myCheckpointStateTable
luabind::object * myCheckpointStateTable
Definition: luaScriptInterfaceImpl.h:570

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

luaScriptInterface::luaSetStatePropertyMapItem
bool luaSetStatePropertyMapItem(lua_State *L, const DtScriptVrfObject &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.

luaScriptInterface::luaSetOrAddStateProperty
bool luaSetOrAddStateProperty(lua_State *L, const DtScriptVrfObject &entity, const std::string &propertyName, luabind::object const &prop, bool addIfNotFound)
Sets the specified state property with the given value.

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

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

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

DtScriptInterface::invokeResume
virtual bool invokeResume()=0

objectCounter.h

DtScriptInterface::loadState
virtual bool loadState(const DtReaderWriter *savedState)=0
Called when the scenario is loaded.

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...

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

luaScriptInterface::luaSetStatePropertyListItemByIndex
bool luaSetStatePropertyListItemByIndex(lua_State *L, const DtScriptVrfObject &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.

DtScriptInterface::invokeCheckInit
virtual void invokeCheckInit()=0

DtLuaScriptInterfaceImpl::LuaExtension::onlyForEntity
const DtVrfObject * onlyForEntity
Definition: luaScriptInterfaceImpl.h:562

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.

DtReaderWriter
Definition: readerWriter.h:85

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

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

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.

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.

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

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:550

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

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}}.

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

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

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.

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::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:558

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.

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

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

DtLuaScriptInterfaceImpl
Definition: luaScriptInterfaceImpl.h:35

ReaderWriterToLuaTableFcn
luabind::object(* ReaderWriterToLuaTableFcn)(lua_State *LS, const DtReaderWriter *rwString, DtVrfObjectManager *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:32

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

scriptInterface.h

DtScriptInterface::invokeDisable
virtual void invokeDisable()=0
Only called for reactive tasks which can be enabled but not active.

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

luaFeatureSet.h

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

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

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

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.

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

DtVrfObjectMessage
The base class for all messages to/from a specific DtVrfObject.
Definition: vrfObjectMessage.h:30

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

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

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.
Definition: scriptInterface.h:39

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.

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...

DtVrfObjectManager
class DtVrfObjectManager:
Definition: vrfObjectManager.h:202

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

translatableStream.h
DtTranslatableStream.

luaScriptInterface::luaGetContactsWithFilter
std::list< DtScriptVrfObject > luaGetContactsWithFilter(lua_State *L, const DtScriptVrfObject &entity, luabind::object const &typeFilters, bool observedOnly)
This function supports the script API.

luaScriptInterface::luaSetStateProperty
bool luaSetStateProperty(lua_State *L, const DtScriptVrfObject &entity, const std::string &propertyName, luabind::object const &prop)
Sets the specified state property with the given value.

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

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

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

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

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

luaScriptInterface::luaSetStatePropertyListItem
bool luaSetStatePropertyListItem(lua_State *L, const DtScriptVrfObject &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.

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

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

luaScriptInterfaceExtension.h
DtLuaScriptInterfaceExtension.

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

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.

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

DtLuaScriptInterfaceImpl::LuaExtension
Definition: luaScriptInterfaceImpl.h:555

luaPathJob.h

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

DtScriptComponentSystem
This class is a wrapper for a DtCompSystem for use by scripts.
Definition: scriptComponentSystem.h:19

DtScriptInterface
This class is a two-way interface between the script language and its parent controller.
Definition: scriptInterface.h:28

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

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.
Definition: setDataRequestMessage.h:23

DtInfluenceInteractionExtension
Instances of DtInfluenceInteractionExtension are used to store state data for Influence interactions ...
Definition: influenceInteractionExtension.h:29

scriptVrfObject.h

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

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.

DtScriptInterface::invokeShutdown
virtual void invokeShutdown()=0

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

DtScriptVrfObject
Definition: scriptVrfObject.h:24

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