3 files changed, 76 insertions, 5 deletions

@@ -0,0 +1,34 @@
+#ifndef AUTOMATABLE_H_FACB42A5
+#define AUTOMATABLE_H_FACB42A5
+
+#include "component.h"
+#include "entity_manager.h"
+
+class AutomatableComponent : public Component {
+public:
+
+  using id_type = EntityManager::id_type;
+
+  /**
+   * Controls what script will be run as this entity's behavior. It should refer
+   * to a table in the global namespace of the script engine state, and that
+   * table should contain a function called "Behavior".
+   */
+  std::string table;
+
+  /**
+   * Whether or not the behavior script is running.
+   *
+   * @managed_by ScriptingSystem
+   */
+  bool running = false;
+
+  /**
+   * The entity ID of the running script, if there is one.
+   *
+   * @managed_by ScriptingSystem
+   */
+  id_type script;
+};
+
+#endif /* end of include guard: AUTOMATABLE_H_FACB42A5 */
@@ -9,14 +9,15 @@ public:
 
   using id_type = EntityManager::id_type;
 
+  /**
+   * The index of the object in the map definition.
+   */
   size_t mapObjectIndex;
 
+  /**
+   * The name of the prototype that the object was spawned from.
+   */
   std::string prototypeId;
-
-  bool hasBehavior = false;
-  bool runningBehavior = false;
-
-  id_type behaviorScript;
 };
 
 #endif /* end of include guard: PROTOTYPABLE_H_817F2205 */
@@ -4,12 +4,48 @@
 #include "component.h"
 #include <sol.hpp>
 #include <memory>
+#include "entity_manager.h"
 
 class RunnableComponent : public Component {
 public:
 
+  using id_type = EntityManager::id_type;
+
+  /**
+   * A Lua stack where the entity's script is running.
+   *
+   * NOTE: This object is called a thread, but there is no multi-threading going
+   * on.
+   *
+   * @managed_by ScriptingSystem
+   */
   std::unique_ptr<sol::thread> runner;
+
+  /**
+   * An entry point to the script running in the runner thread.
+   *
+   * @managed_by ScriptingSystem
+   */
   std::unique_ptr<sol::coroutine> callable;
+
+  /**
+   * Whether or not this entity represents a behavior script. A behavior script
+   * usually does not terminate on its own, and can be terminated at will by
+   * another system, usually when the automatable entity leaves the active map.
+   *
+   * @managed_by ScriptingSystem
+   */
+  bool behavior = false;
+
+  /**
+   * If this is a behavior script, this is the ID of the automatable entity that
+   * the behavior belongs to. This is required so that the ScriptingSystem can
+   * notify the automatable entity if the behavior script terminates by itself,
+   * and that it shouldn't attempt to terminate it.
+   *
+   * @managed_by ScriptingSystem
+   */
+  id_type actor;
 };
 
 #endif /* end of include guard: AUTOMATABLE_H_3D519131 */