From 5e48cf6333aca7af6854d79194f138d57ce0b5e1 Mon Sep 17 00:00:00 2001
From: Kelly Rauchenberger <fefferburbia@gmail.com>
Date: Mon, 14 May 2018 18:40:54 -0400
Subject: Specialized treatment of behavior scripts

The AutomatableComponent now links to the Runnable entity representing the behavior script.

Also reordered the SystemManager and EntityManager members of the Game class such that the EntityManager is destroyed before the SystemManager is. This fixes a bug where the destruction of a component has some affect on the state of a system. Specifically, if the ScriptingSystem (and thus the Lua state) is destroyed before the EntityManager is and there are any Runnable entities, the game will crash when trying to destroy them.
---
 src/components/automatable.h  | 34 ++++++++++++++++++++++++++++++++++
 src/components/prototypable.h | 11 ++++++-----
 src/components/runnable.h     | 36 ++++++++++++++++++++++++++++++++++++
 3 files changed, 76 insertions(+), 5 deletions(-)
 create mode 100644 src/components/automatable.h

(limited to 'src/components')

diff --git a/src/components/automatable.h b/src/components/automatable.h
new file mode 100644
index 0000000..22d9859
--- /dev/null
+++ b/src/components/automatable.h
@@ -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 */
diff --git a/src/components/prototypable.h b/src/components/prototypable.h
index 4659e7c..c0dd972 100644
--- a/src/components/prototypable.h
+++ b/src/components/prototypable.h
@@ -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 */
diff --git a/src/components/runnable.h b/src/components/runnable.h
index 1b994fb..956bfdc 100644
--- a/src/components/runnable.h
+++ b/src/components/runnable.h
@@ -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 */
-- 
cgit 1.4.1