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/systems/realizing.cpp | 33 ++++++----------------
 src/systems/scripting.cpp | 70 +++++++++++++++++++++++++++++++++++++++--------
 src/systems/scripting.h   | 10 +++++--
 3 files changed, 76 insertions(+), 37 deletions(-)

(limited to 'src/systems')

diff --git a/src/systems/realizing.cpp b/src/systems/realizing.cpp
index 7f5aefb..baacf5a 100644
--- a/src/systems/realizing.cpp
+++ b/src/systems/realizing.cpp
@@ -12,6 +12,7 @@
 #include "components/ponderable.h"
 #include "components/transformable.h"
 #include "components/prototypable.h"
+#include "components/automatable.h"
 #include "systems/mapping.h"
 #include "systems/animating.h"
 #include "systems/pondering.h"
@@ -223,7 +224,10 @@ RealizingSystem::RealizingSystem(
 
           if (prototypeId == "movplat")
           {
-            prototypable.hasBehavior = true;
+            auto& automatable = game_.getEntityManager().
+              emplaceComponent<AutomatableComponent>(mapObject);
+
+            automatable.table = prototypeId;
           } else if (prototypeId == "checkpoint")
           {
             auto& ponderable = game_.getEntityManager().
@@ -403,19 +407,9 @@ void RealizingSystem::enterActiveMap(id_type entity)
     ponderable.active = true;
   }
 
-  if (game_.getEntityManager().hasComponent<PrototypableComponent>(entity))
+  if (game_.getEntityManager().hasComponent<AutomatableComponent>(entity))
   {
-    auto& prototypable = game_.getEntityManager().
-      getComponent<PrototypableComponent>(entity);
-
-    if (prototypable.hasBehavior)
-    {
-      auto& scripting = game_.getSystemManager().getSystem<ScriptingSystem>();
-
-      prototypable.hasBehavior = true;
-      prototypable.runningBehavior = true;
-      prototypable.behaviorScript = scripting.runBehaviorScript(entity);
-    }
+    game_.getSystemManager().getSystem<ScriptingSystem>().startBehavior(entity);
   }
 }
 
@@ -437,17 +431,8 @@ void RealizingSystem::leaveActiveMap(id_type entity)
     ponderable.active = false;
   }
 
-  if (game_.getEntityManager().hasComponent<PrototypableComponent>(entity))
+  if (game_.getEntityManager().hasComponent<AutomatableComponent>(entity))
   {
-    auto& prototypable = game_.getEntityManager().
-      getComponent<PrototypableComponent>(entity);
-
-    if (prototypable.runningBehavior)
-    {
-      auto& scripting = game_.getSystemManager().getSystem<ScriptingSystem>();
-      scripting.killScript(prototypable.behaviorScript);
-
-      prototypable.runningBehavior = false;
-    }
+    game_.getSystemManager().getSystem<ScriptingSystem>().stopBehavior(entity);
   }
 }
diff --git a/src/systems/scripting.cpp b/src/systems/scripting.cpp
index 57c3fd5..c423558 100644
--- a/src/systems/scripting.cpp
+++ b/src/systems/scripting.cpp
@@ -6,6 +6,7 @@
 #include "components/playable.h"
 #include "components/mappable.h"
 #include "components/prototypable.h"
+#include "components/automatable.h"
 #include "systems/realizing.h"
 #include "vector.h"
 
@@ -133,28 +134,34 @@ void ScriptingSystem::tick(double dt)
 
     if (!*runnable.callable)
     {
-      game_.getEntityManager().deleteEntity(entity);
+      killScript(entity);
     }
   }
 }
 
 void ScriptingSystem::killScript(id_type entity)
 {
-  if (game_.getEntityManager().hasComponent<RunnableComponent>(entity))
+  auto& runnable = game_.getEntityManager().
+    getComponent<RunnableComponent>(entity);
+
+  if (runnable.behavior)
   {
-    game_.getEntityManager().deleteEntity(entity);
+    auto& automatable = game_.getEntityManager().
+      getComponent<AutomatableComponent>(runnable.actor);
+
+    automatable.running = false;
   }
+
+  game_.getEntityManager().deleteEntity(entity);
 }
 
 template <typename... Args>
-EntityManager::id_type ScriptingSystem::runScript(
+sol::optional<EntityManager::id_type> ScriptingSystem::runScript(
+  std::string table,
   std::string event,
   id_type entity,
   Args&&... args)
 {
-  auto& prototypable = game_.getEntityManager().
-    getComponent<PrototypableComponent>(entity);
-
   id_type script = game_.getEntityManager().emplaceEntity();
 
   auto& runnable = game_.getEntityManager().
@@ -171,7 +178,7 @@ EntityManager::id_type ScriptingSystem::runScript(
       new sol::coroutine(
         runnable.runner->state().
           traverse_get<sol::function>(
-            prototypable.prototypeId,
+            table,
             event)));
 
   if (!*runnable.callable)
@@ -189,17 +196,58 @@ EntityManager::id_type ScriptingSystem::runScript(
     throw std::runtime_error(e.what());
   }
 
-  return script;
+  if (*runnable.callable)
+  {
+    return { script };
+  } else {
+    killScript(script);
+
+    return {};
+  }
+}
+
+void ScriptingSystem::startBehavior(id_type entity)
+{
+  auto& automatable = game_.getEntityManager().
+    getComponent<AutomatableComponent>(entity);
+
+  sol::optional<id_type> script =
+    runScript(
+      automatable.table,
+      "Behavior",
+      entity);
+
+  if (script)
+  {
+    automatable.script = *script;
+    automatable.running = true;
+
+    auto& runnable = game_.getEntityManager().
+      getComponent<RunnableComponent>(automatable.script);
+
+    runnable.behavior = true;
+    runnable.actor = entity;
+  }
 }
 
-EntityManager::id_type ScriptingSystem::runBehaviorScript(id_type entity)
+void ScriptingSystem::stopBehavior(id_type entity)
 {
-  return runScript("Behavior", entity);
+  auto& automatable = game_.getEntityManager().
+    getComponent<AutomatableComponent>(entity);
+
+  if (automatable.running)
+  {
+    killScript(automatable.script);
+  }
 }
 
 void ScriptingSystem::onTouch(id_type entity, id_type player)
 {
+  auto& prototypable = game_.getEntityManager().
+    getComponent<PrototypableComponent>(entity);
+
   runScript(
+    prototypable.prototypeId,
     "OnTouch",
     entity,
     script_entity(player));
diff --git a/src/systems/scripting.h b/src/systems/scripting.h
index e330316..b119c3f 100644
--- a/src/systems/scripting.h
+++ b/src/systems/scripting.h
@@ -13,14 +13,20 @@ public:
 
   void killScript(id_type entity);
 
-  id_type runBehaviorScript(id_type entity);
+  void startBehavior(id_type entity);
+
+  void stopBehavior(id_type entity);
 
   void onTouch(id_type entity, id_type player);
 
 private:
 
   template <typename... Args>
-  id_type runScript(std::string event, id_type entity, Args&&... args);
+  sol::optional<id_type> runScript(
+    std::string table,
+    std::string event,
+    id_type entity,
+    Args&&... args);
 
   sol::state engine_;
 };
-- 
cgit 1.4.1