Added a debug console

Open it by pressing backtick, close it by hitting escape. Pressing backtick does not open it in release builds.

Current shortcomings: opening it for the first time also types a backtick for some reason, but not on subsequent times. Also, it doesn't create a coroutine, so any script function that yields is going to fail.

This also added a "is gameplay paused" flag to Game, which will be useful for adding a pause menu.

14 files changed, 150 insertions, 2 deletions

@@ -16,6 +16,8 @@ find_package(SDL2 REQUIRED)
 find_package(SDL2_image REQUIRED)
 find_package(SDL2_mixer REQUIRED)
 
+set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -DTANETANE_DEBUG")
+
 set(ALL_LIBS
   ${SDL2_LIBRARY}
   ${SDL2_IMAGE_LIBRARIES}
@@ -91,6 +91,8 @@ void AnimationSystem::initSprite(int spriteId, std::string_view filename) {
 }
 
 void AnimationSystem::tick(double dt) {
+  if (game_.isGameplayPaused()) return;
+
   animTimer_.accumulate(dt);
   while (animTimer_.step()) {
     for (Sprite& sprite : game_.getSprites() | game_.spriteView()) {
@@ -5,6 +5,8 @@
 #include "direction.h"
 
 void BehaviourSystem::tick(double dt) {
+  if (game_.isGameplayPaused()) return;
+
   timer_.accumulate(dt);
   while (timer_.step()) {
     for (int spriteId : game_.getSprites()) {
@@ -4,6 +4,8 @@
 #include "map.h"
 
 void CameraSystem::tick(double dt) {
+  if (game_.isGameplayPaused()) return;
+
   if (!locked_ && followingSprite_ != -1) {
     const Sprite& follow = game_.getSprite(followingSprite_);
 
@@ -91,6 +91,8 @@ void CharacterSystem::stopDirecting(int spriteId) {
 }
 
 void CharacterSystem::tick(double dt) {
+  if (game_.isGameplayPaused()) return;
+
   inputTimer_.accumulate(dt);
   while (inputTimer_.step()) {
     for (int spriteId : game_.getSprites()) {
@@ -1,6 +1,9 @@
 #include "effect_system.h"
+#include "game.h"
 
 void EffectSystem::tick(double dt) {
+  if (game_.isGameplayPaused()) return;
+
   if (screenFade_ != screenFadeDest_) {
     screenFadeThus_ += dt;
     if (screenFadeThus_ >= screenFadeLength_) {
@@ -86,6 +86,12 @@ public:
 
   std::mt19937& getRng() { return *rng_; }
 
+  void pauseGameplay() { paused_ = true; }
+
+  void unpauseGameplay() { paused_ = false; }
+
+  bool isGameplayPaused() const { return paused_; }
+
 private:
 
   Mixer mixer_;
@@ -101,6 +107,7 @@ private:
   std::unique_ptr<Map> map_;
   Font font_;
   std::mt19937* rng_;
+  bool paused_ = false;
 };
 
 #endif /* end of include guard: GAME_H_E6F1396E */
@@ -16,12 +16,42 @@ struct Input {
 void InputSystem::tick(double dt) {
   SDL_Event e;
   while (SDL_PollEvent(&e)) {
-    if (e.type == SDL_QUIT || (e.type == SDL_KEYDOWN && e.key.keysym.sym == SDLK_ESCAPE)) {
+    if (e.type == SDL_KEYDOWN && e.key.keysym.sym == SDLK_ESCAPE) {
+      if (debugConsole_) {
+        debugConsole_ = false;
+        game_.unpauseGameplay();
+        SDL_StopTextInput();
+        debugText_.clear();
+      } else {
+        game_.quit();
+      }
+    } else if (e.type == SDL_QUIT) {
       game_.quit();
 
       return;
+    } else if (e.type == SDL_TEXTINPUT) {
+      debugText_.append(e.text.text);
     } else if (e.type == SDL_KEYDOWN) {
-      if (e.key.keysym.sym == SDLK_LSHIFT || e.key.keysym.sym == SDLK_RSHIFT) {
+      if (e.key.keysym.sym == SDLK_BACKQUOTE) {
+#ifdef TANETANE_DEBUG
+        if (!debugConsole_) {
+          debugConsole_ = true;
+          game_.pauseGameplay();
+          SDL_StartTextInput();
+          debugText_.clear();
+        }
+#endif
+      } else if (debugConsole_ && e.key.keysym.sym == SDLK_RETURN) {
+        game_.getSystem<ScriptSystem>().runDebugScript(debugText_);
+        debugText_.clear();
+      } else if (debugConsole_ && e.key.keysym.sym == SDLK_BACKSPACE) {
+        // Make sure to keep the backtick/heart.
+        if (!debugText_.empty()) {
+          debugText_.pop_back();
+        }
+      } else if (e.key.keysym.sym == SDLK_LSHIFT || e.key.keysym.sym == SDLK_RSHIFT) {
+        if (game_.isGameplayPaused()) continue;
+
         for (int spriteId : game_.getSprites()) {
           Sprite& sprite = game_.getSprite(spriteId);
           if (sprite.controllable) {
@@ -29,6 +59,8 @@ void InputSystem::tick(double dt) {
           }
         }
       } else if (e.key.keysym.sym == SDLK_SPACE) {
+        if (game_.isGameplayPaused()) continue;
+
         // If there is text on screen, try to advance it.
         if (game_.getSystem<MessageSystem>().getCutsceneBarsProgress() != 0.0) {
           game_.getSystem<MessageSystem>().advanceText();
@@ -75,15 +107,21 @@ void InputSystem::tick(double dt) {
           }
         }
       } else if (e.key.keysym.sym == SDLK_LEFT) {
+        if (game_.isGameplayPaused()) continue;
+
         if (game_.getSystem<MessageSystem>().isChoiceActive()) {
           game_.getSystem<MessageSystem>().selectFirstChoice();
         }
       } else if (e.key.keysym.sym == SDLK_RIGHT) {
+        if (game_.isGameplayPaused()) continue;
+
         if (game_.getSystem<MessageSystem>().isChoiceActive()) {
           game_.getSystem<MessageSystem>().selectSecondChoice();
         }
       }
     } else if (e.type == SDL_KEYUP && (e.key.keysym.sym == SDLK_LSHIFT || e.key.keysym.sym == SDLK_RSHIFT)) {
+      if (game_.isGameplayPaused()) continue;
+
       for (int spriteId : game_.getSprites()) {
         Sprite& sprite = game_.getSprite(spriteId);
         if (sprite.controllable) {
@@ -93,6 +131,8 @@ void InputSystem::tick(double dt) {
     }
   }
 
+  if (game_.isGameplayPaused()) return;
+
   Input keystate;
   const Uint8* state = SDL_GetKeyboardState(NULL);
   keystate.left = state[SDL_SCANCODE_LEFT];
@@ -1,6 +1,7 @@
 #ifndef INPUT_SYSTEM_H_47764575
 #define INPUT_SYSTEM_H_47764575
 
+#include <string>
 #include "system.h"
 
 class Game;
@@ -14,9 +15,15 @@ public:
 
   void tick(double dt) override;
 
+  bool isDebugConsoleOpen() const { return debugConsole_; }
+
+  const std::string& getDebugText() const { return debugText_; }
+
 private:
 
   Game& game_;
+  bool debugConsole_ = false;
+  std::string debugText_;
 };
 
 #endif /* end of include guard: INPUT_SYSTEM_H_47764575 */
@@ -6,6 +6,8 @@ const int CHARS_TO_REVEAL = 1;
 const int CHARS_PER_BEEP = 8;
 
 void MessageSystem::tick(double dt) {
+  if (game_.isGameplayPaused()) return;
+
   if (barsState_ == BarsState::Opening || barsState_ == BarsState::Closing) {
     accum_ += dt;
 
@@ -7,6 +7,7 @@
 #include "camera_system.h"
 #include "message_system.h"
 #include "effect_system.h"
+#include "input_system.h"
 
 Renderer::Renderer() {
   win_ = window_ptr(
@@ -333,6 +334,61 @@ void Renderer::render(Game& game) {
     SDL_RenderFillRect(ren_.get(), nullptr);
   }
 
+  if (game.getSystem<InputSystem>().isDebugConsoleOpen()) {
+    // Not sure why I'm supposed to copy the cached texture to the screen
+    // BEFORE rendering it, but we get flickering if we don't, so.
+    SDL_RenderCopy(ren_.get(), debugConsoleTex_.get(), nullptr, &debugDestRect_);
+
+    if (!debugConsoleTex_ || cachedDebugText_ != game.getSystem<InputSystem>().getDebugText()) {
+      cachedDebugText_ = game.getSystem<InputSystem>().getDebugText();
+
+      std::vector<texture_ptr> textLines;
+      std::string remaining = "`" + cachedDebugText_;
+
+      while (!remaining.empty()) {
+        MessageCache output;
+        renderMessageLine(output, remaining, game);
+        textLines.push_back(std::move(output.renderedTex));
+        remaining = output.overflow;
+
+        if (!remaining.empty()) {
+          remaining = "   " + remaining;
+        }
+      }
+
+      int height = 16 * textLines.size() + 4 + 4;
+
+      debugConsoleTex_.reset(
+        SDL_CreateTexture(
+          ren_.get(),
+          SDL_PIXELFORMAT_RGBA8888,
+          SDL_TEXTUREACCESS_TARGET,
+          CANVAS_WIDTH,
+          height));
+
+      SDL_SetRenderTarget(ren_.get(), debugConsoleTex_.get());
+      SDL_SetTextureBlendMode(debugConsoleTex_.get(), SDL_BLENDMODE_BLEND);
+      SDL_SetRenderDrawBlendMode(ren_.get(), SDL_BLENDMODE_BLEND);
+      SDL_SetRenderDrawColor(ren_.get(), 30, 0, 110, 127);
+      //SDL_RenderFillRect(ren_.get(), nullptr);
+      SDL_RenderClear(ren_.get());
+
+      for (int i=0; i<textLines.size(); i++) {
+        SDL_Rect destRect {
+          18,
+          4 + 16 * i,
+          MESSAGE_TEXT_WIDTH,
+          game.getFont().getCharacterHeight() };
+
+        SDL_RenderCopy(ren_.get(), textLines[i].get(), nullptr, &destRect);
+      }
+
+      SDL_SetRenderTarget(ren_.get(), nullptr);
+
+      debugDestRect_ = SDL_Rect { 0, 0, CANVAS_WIDTH, height };
+    }
+  }
+
   SDL_SetRenderTarget(ren_.get(), nullptr);
   SDL_RenderCopy(ren_.get(), cameraTex.get(), nullptr, nullptr);
   SDL_RenderPresent(ren_.get());
@@ -383,6 +439,11 @@ void Renderer::renderMessageLine(MessageCache& line, const std::string& text, Ga
 
   for (int i=0; i<line.line.size(); i++) {
     if (line.line[i] != ' ') {
+      if (length + game.getFont().getCharacterWidth(line.line[i]) > MESSAGE_TEXT_WIDTH) {
+        line.overflow = line.line.substr(i);
+        break;
+      }
+
       vec2i charLoc = game.getFont().getCharacterLocation(line.line[i]);
       vec2i charSize = game.getFont().getCharacterSize(line.line[i]);
       SDL_Rect srcRect { charLoc.x(), charLoc.y(), charSize.w(), charSize.h() };
@@ -152,6 +152,7 @@ private:
     texture_ptr renderedTex;
     std::vector<int> charIndexToWidth;
     std::string line;
+    std::string overflow;
   };
 
   void renderMessageLine(MessageCache& line, const std::string& text, Game& game);
@@ -161,6 +162,11 @@ private:
   MessageCache speakerHeaderLine_;
   int advMsgArrowTex_ = -1;
   int choiceArrowTex_ = -1;
+
+  // Debug console
+  texture_ptr debugConsoleTex_;
+  std::string cachedDebugText_;
+  SDL_Rect debugDestRect_;
 };
 
 #endif /* end of include guard: RENDERER_H_6A58EC30 */
@@ -190,6 +190,8 @@ ScriptSystem::ScriptSystem(Game& game) : game_(game) {
 }
 
 void ScriptSystem::tick(double dt) {
+  if (game_.isGameplayPaused()) return;
+
   if (callable_ && *callable_) {
     auto result = (*callable_)(dt);
     if (!result.valid()) {
@@ -228,3 +230,11 @@ void ScriptSystem::runScript(std::string mapName, std::string scriptName) {
     runner_.reset();
   }
 }
+
+void ScriptSystem::runDebugScript(std::string script) {
+  auto result = engine_.script(script);
+  if (!result.valid()) {
+    sol::error e = result;
+    std::cout << e.what() << std::endl;
+  }
+}
@@ -20,6 +20,8 @@ public:
 
   void runScript(std::string mapName, std::string scriptName);
 
+  void runDebugScript(std::string script);
+
 private:
 
   Game& game_;