fix: Fix gas saturation, #34

Only check vespene workers every 7 gameloops, to prevent too many vespene workers from being added and oversaturated. Also, create functionality for other Plugin-derived classes to run every X gameloops.

Author: ImpulseCloud

src/Dispatcher.cpp

@@ -90,8 +90,12 @@ void Dispatcher::OnStep() {
 
     gHub->OnStep();
 
-    for (const auto& i : m_plugins)
-        i->OnStep(m_builder.get());
+    for (const auto& i : m_plugins) {
+        if (i->GetNextRunGameLoop() <= gAPI->observer().GetGameLoop()) {
+            i->OnStep(m_builder.get());
+            i->UpdateNextRunGameLoop();
+        }
+    }
 
     m_builder->OnStep();
 }

src/plugins/Miner.cpp

@@ -138,6 +138,9 @@ void DistrubuteMineralWorker(const sc2::Unit* unit_) {
 
 }  // namespace
 
+Miner::Miner(): Plugin(7) {
+}
+
 void Miner::OnStep(Builder* builder_) {
     SecureMineralsIncome(builder_);
     SecureVespeneIncome();
@@ -151,7 +154,12 @@ void Miner::OnUnitCreated(const sc2::Unit* unit_, Builder*) {
         DistrubuteMineralWorker(unit_);
 }
 
-void Miner::OnUnitIdle(const sc2::Unit* unit_, Builder*) {
+void Miner::OnUnitIdle(const sc2::Unit* unit_, Builder* builder_) {
     if (unit_->unit_type == gHub->GetCurrentWorkerType())
         DistrubuteMineralWorker(unit_);
+
+    if (sc2::IsTownHall()(unit_->unit_type) &&
+        unit_->assigned_harvesters <= unit_->ideal_harvesters &&
+        builder_->CountScheduledOrders(gHub->GetCurrentWorkerType()) < 1)
+        builder_->ScheduleOptionalOrder(gHub->GetCurrentWorkerType(), unit_);
 }

src/plugins/Miner.h

@@ -8,6 +8,8 @@
 #include "Plugin.h"
 
 struct Miner : Plugin {
+    Miner();
+
     void OnStep(Builder* builder_) final;
 
     void OnUnitCreated(const sc2::Unit* unit_, Builder*) final;

src/plugins/Plugin.cpp

@@ -0,0 +1,21 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2017-2020 Alexander Kurbatov
+
+#include "Plugin.h"
+#include "core/API.h"
+
+Plugin::Plugin(): m_gameloop_frequency(1), m_next_run_gameloop(0) {
+}
+
+Plugin::Plugin(uint32_t gameloop_frequency): m_gameloop_frequency(gameloop_frequency),
+    m_next_run_gameloop(0) {
+}
+
+uint32_t Plugin::GetNextRunGameLoop() const {
+    return m_next_run_gameloop;
+}
+
+void Plugin::UpdateNextRunGameLoop() {
+    m_next_run_gameloop = m_gameloop_frequency + gAPI->observer().GetGameLoop();
+}

src/plugins/Plugin.h

@@ -9,6 +9,10 @@
 #include <sc2api/sc2_unit.h>
 
 struct Plugin {
+    Plugin();
+
+    explicit Plugin(uint32_t gameloop_frequency);
+
     virtual ~Plugin() {
     }
 
@@ -38,4 +42,12 @@ struct Plugin {
 
     virtual void OnGameEnd() {
     }
+
+    virtual uint32_t GetNextRunGameLoop() const;
+
+    virtual void UpdateNextRunGameLoop();
+
+ private:
+    const uint32_t m_gameloop_frequency;
+    uint32_t m_next_run_gameloop;
 };