Release 0.9.0

bot/modules/game_environment/__init__.py

@@ -0,0 +1,101 @@
+from bot.module import Module
+from bot import loaded_modules_dict
+from time import time
+
+
+class Environment(Module):
+    templates = object
+
+    def __init__(self):
+        setattr(self, "default_options", {
+            "module_name": self.get_module_identifier()[7:],
+            "dom_element_root": [],
+            "dom_element_select_root": ["id"],
+            "run_observer_interval": 3
+        })
+
+        setattr(self, "required_modules", [
+            "module_dom",
+            "module_dom_management",
+            "module_telnet",
+            "module_webserver"
+        ])
+
+        self.next_cycle = 0
+        Module.__init__(self)
+
+    @staticmethod
+    def get_module_identifier():
+        return "module_game_environment"
+
+    def on_socket_connect(self, steamid):
+        Module.on_socket_connect(self, steamid)
+
+    def on_socket_disconnect(self, steamid):
+        Module.on_socket_disconnect(self, steamid)
+
+    # region Standard module stuff
+    def setup(self, options=dict):
+        Module.setup(self, options)
+        self.dom_element_root = self.options.get(
+            "dom_element_root", self.default_options.get("dom_element_root", None)
+        )
+        self.dom_element_select_root = self.options.get(
+            "dom_element_select_root", self.default_options.get("dom_element_select_root", None)
+        )
+        self.run_observer_interval = self.options.get(
+            "run_observer_interval", self.default_options.get("run_observer_interval", None)
+        )
+
+    # endregion
+    def get_last_recorded_gametime_dict(self):
+        active_dataset = self.dom.data.get("module_game_environment", {}).get("active_dataset", None)
+        if active_dataset is None:
+            return None
+
+        return (
+             self.dom.data
+             .get("module_game_environment", {})
+             .get(active_dataset, {})
+             .get("last_recorded_gametime", {})
+        )
+
+    def get_last_recorded_gametime_string(self):
+        last_recorded_gametime_dict = self.get_last_recorded_gametime_dict()
+        if last_recorded_gametime_dict is None:
+            return "Day {day}, {hour}:{minute}".format(
+                day="n/a",
+                hour="n/a",
+                minute="n/a"
+            )
+
+        return "Day {day}, {hour}:{minute}".format(
+            day=last_recorded_gametime_dict.get("day", "n/a"),
+            hour=last_recorded_gametime_dict.get("hour", "n/a"),
+            minute=last_recorded_gametime_dict.get("minute", "n/a")
+        )
+
+    def run(self):
+        while not self.stopped.wait(self.next_cycle):
+            profile_start = time()
+
+            self.trigger_action_hook(self, event_data=["getgameprefs", {
+                "disable_after_success": True
+            }])
+
+            # requires getgameprefs to be successful
+            self.trigger_action_hook(self, event_data=["getgamestats", {
+                "disable_after_success": True
+            }])
+
+            self.trigger_action_hook(self, event_data=["gettime", {}])
+
+            self.trigger_action_hook(self, event_data=["getentities", {}])
+
+            self.execute_telnet_triggers()
+
+            self.last_execution_time = time() - profile_start
+            self.next_cycle = self.run_observer_interval - self.last_execution_time
+
+
+loaded_modules_dict[Environment().get_module_identifier()] = Environment()