Changeset 7404 for code/trunk/src/modules/objects/Script.cc

Timestamp:

Sep 11, 2010, 2:42:47 PM (14 years ago)

Author:

dafrick

Message:

Adding new level notifications.oxw, to "showcase", or at this stage rather "test" Notifications.
Restoring tutorial.oxw to its old state, before it was hijacked by me for testing.

Extending Script class. Now also normal orxonox code can be executed with it, the execution of code can be triggered with Triggers (obviously) and cod can also executed on load.
I needed this to load the NotificationLayer in levels where it is needed.
Also inserted a Script that loads the NotificationQueue to display Notifications in all levels it was needed.

File:

• code/trunk/src/modules/objects/Script.cc (modified) (3 diffs)

code/trunk/src/modules/objects/Script.cc

@@ -23 +23 @@
  *      Benjamin Knecht
  *   Co-authors:
- *      ...
+ *      Damian 'Mozork' Frick
  *
  */
@@ -29 +29 @@
 #include "Script.h"
 
+#include "core/command/CommandExecutor.h"
 #include "core/CoreIncludes.h"
+#include "core/EventIncludes.h"
 #include "core/LuaState.h"
 #include "core/XMLPort.h"
@@ -37 +39 @@
     CreateFactory(Script);
 
+    // Initializing constants.
+    /*static*/ const std::string Script::NORMAL = "normal";
+    /*static*/ const std::string Script::LUA = "lua";
+
+    /**
+    @brief
+        Constructor. Registers and initializes the object.
+    @param creator
+        The creator of this object.
+    */
     Script::Script(BaseObject* creator) : BaseObject(creator)
     {
         RegisterObject(Script);
 
-        // Get a new LuaState
-        luaState_ = new LuaState();
-    }
-
+        // Initialize variables.
+        this->luaState_ = NULL;
+        this->remainingExecutions_ = Script::INF;
+
+    }
+
+    /**
+    @brief
+        Destructor. Cleans up.
+    */
     Script::~Script()
     {
-        if (this->isInitialized())
-            delete luaState_;
-    }
-
-    void Script::XMLPort(Element& xmlelement, XMLPort::Mode mode)
-    {
-        BaseObject::XMLPort(xmlelement, mode);
-
-        XMLPortParam(Script, "code", setCode, getCode, xmlelement, mode);
-    }
-
+        if(this->isInitialized() && this->luaState_ != NULL)
+            delete this->luaState_;
+    }
+
+    /**
+    @brief
+        Method for creating a Script object through XML.
+    @param xmlElement
+        The element.
+    @param mode
+        The mode.
+    */
+    void Script::XMLPort(Element& xmlElement, XMLPort::Mode mode)
+    {
+        SUPER(Script, XMLPort, xmlElement, mode);
+
+        XMLPortParam(Script, "code", setCode, getCode, xmlElement, mode);
+        XMLPortParamTemplate(Script, "mode", setMode, getMode, xmlElement, mode, const std::string&).defaultValues(Script::NORMAL);
+        XMLPortParam(Script, "onLoad", setOnLoad, isOnLoad, xmlElement, mode).defaultValues(true);
+        XMLPortParam(Script, "times", setTimes, getTimes, xmlElement, mode).defaultValues(Script::INF);
+
+        XMLPortEventSink(Script, BaseObject, "trigger", trigger, xmlElement, mode);
+
+        if(this->isOnLoad()) // If the object is onLoad the code is executed at once.
+            this->execute();
+    }
+
+    /**
+    @brief
+        Creates a port that can be used to channel events and react to them.
+    @param xmlElement
+        The element.
+    @param mode
+        The mode.
+    */
+    void Script::XMLEventPort(Element& xmlElement, XMLPort::Mode mode)
+    {
+        SUPER(Script, XMLEventPort, xmlElement, mode);
+
+        XMLPortEventState(Script, BaseObject, "trigger", trigger, xmlElement, mode);
+    }
+
+    /**
+    @brief
+        Is called when an event comes in trough the event port.
+    @param triggered
+        Whether the event is triggering or un-triggering.
+    */
+    void Script::trigger(bool triggered)
+    {
+        if(triggered) // If the event is triggering (instead of un-triggering) the code of this Script  is executed.
+            this->execute();
+    }
+
+    /**
+    @brief
+        Executes the Scripts code, depending on the mode.
+    */
     void Script::execute()
     {
-        luaState_->doString(code_);
-    }
+        if(this->times_ != Script::INF && this->remainingExecutions_ == 0)
+            return;
+
+        if(this->mode_ == ScriptMode::normal) // If the mode is 'normal'.
+            CommandExecutor::execute(this->code_);
+        else if(this->mode_ == ScriptMode::lua) // If it's 'lua'.
+        {
+            assert(this->luaState_);
+            this->luaState_->doString(this->code_);
+        }
+
+        if(this->times_ != Script::INF)
+            this->remainingExecutions_--;
+    }
+
+    /**
+    @brief
+        Sets the mode of the Script.
+    @param mode
+        The mode as a string.
+    */
+    void Script::setMode(const std::string& mode)
+    {
+        if(mode == Script::NORMAL)
+            this->setMode(ScriptMode::normal);
+        else if(mode == Script::LUA)
+        {
+            this->setMode(ScriptMode::lua);
+            // Creates a new LuaState.
+            if(this->luaState_ == NULL)
+                this->luaState_ = new LuaState();
+        }
+        else
+        {
+            COUT(2) << "Invalid mode '" << mode << "' in Script object." << std::endl;
+            this->setMode(ScriptMode::normal);
+        }
+    }
+
+    /**
+    @brief
+        Get the mode of the Script.
+    @return
+        Returns the mode as a string.
+    */
+    const std::string& Script::getMode(void)
+    {
+        switch(this->mode_)
+        {
+            case ScriptMode::normal:
+                return Script::NORMAL;
+            case ScriptMode::lua:
+                return Script::LUA;
+        }
+    }
+
+    /**
+    @brief
+        Set the number of times this Script is executed at the most.
+        -1 denotes infinity.
+    @param times
+        The number of times to be set.
+    */
+    void Script::setTimes(int times)
+    {
+        if(times >= -1)
+        {
+            this->times_ = times;
+            this->remainingExecutions_ = times;
+        }
+        else
+        {
+            COUT(2) << "Invalid times '" << times << "' in Script." << std::endl;
+            this->times_ = Script::INF;
+        }
+    }
+
 }