src/client/gameui.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4 Copyright (C) 2018 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU Lesser General Public License as published by
   8 the Free Software Foundation; either version 2.1 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU Lesser General Public License for more details.
  15
  16 You should have received a copy of the GNU Lesser General Public License along
  17 with this program; if not, write to the Free Software Foundation, Inc.,
  18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 */
  20
  21 #pragma once
  22
  23 #include <IGUIEnvironment.h>
  24 #include "gui/guiFormSpecMenu.h"
  25 #include "util/enriched_string.h"
  26 #include "util/pointedthing.h"
  27 #include "game.h"
  28
  29 using namespace irr;
  30 class Client;
  31 class GUIChatConsole;
  32 struct MapDrawControl;
  33
  34 /*
  35  * This object intend to contain the core UI elements
  36  * It includes:
  37  *   - status texts
  38  *   - debug texts
  39  *   - chat texts
  40  *   - hud flags
  41  */
  42 class GameUI
  43 {
  44         // Temporary between coding time to move things here
  45         friend class Game;
  46
  47         // Permit unittests to access members directly
  48         friend class TestGameUI;
  49
  50 public:
  51         GameUI();
  52         ~GameUI() = default;
  53
  54         // Flags that can, or may, change during main game loop
  55         struct Flags
  56         {
  57                 bool show_chat = true;
  58                 bool show_hud = true;
  59                 bool show_minimap = false;
  60                 bool show_debug = true;
  61                 bool show_profiler_graph = false;
  62                 bool show_cheat_menu = true;
  63         };
  64
  65         void init();
  66         void update(const RunStats &stats, Client *client, MapDrawControl *draw_control,
  67                         const CameraOrientation &cam, const PointedThing &pointed_old,
  68                         const GUIChatConsole *chat_console, float dtime);
  69
  70         void initFlags();
  71         const Flags &getFlags() const { return m_flags; }
  72
  73         void showMinimap(bool show);
  74
  75         inline void setInfoText(const std::wstring &str) { m_infotext = str; }
  76         inline void clearInfoText() { m_infotext.clear(); }
  77
  78         inline void showStatusText(const std::wstring &str)
  79         {
  80                 m_statustext = str;
  81                 m_statustext_time = 0.0f;
  82         }
  83         void showTranslatedStatusText(const char *str);
  84         inline void clearStatusText() { m_statustext.clear(); }
  85
  86         const bool isChatVisible()
  87         {
  88                 return m_flags.show_chat && m_recent_chat_count != 0 && m_profiler_current_page == 0;
  89         }
  90         void setChatText(const EnrichedString &chat_text, u32 recent_chat_count);
  91
  92         void updateProfiler();
  93
  94         void toggleChat();
  95         void toggleCheatMenu();
  96         void toggleHud();
  97         void toggleProfiler();
  98
  99         GUIFormSpecMenu *&updateFormspec(const std::string &formname)
 100         {
 101                 m_formname = formname;
 102                 return m_formspec;
 103         }
 104
 105         const std::string &getFormspecName() { return m_formname; }
 106         GUIFormSpecMenu *&getFormspecGUI() { return m_formspec; }
 107         void deleteFormspec();
 108
 109 private:
 110         Flags m_flags;
 111
 112         gui::IGUIStaticText *m_guitext = nullptr;  // First line of debug text
 113         gui::IGUIStaticText *m_guitext2 = nullptr; // Second line of debug text
 114         gui::IGUIStaticText *m_guitext_coords = nullptr;
 115
 116         gui::IGUIStaticText *m_guitext_info = nullptr; // At the middle of the screen
 117         std::wstring m_infotext;
 118
 119         gui::IGUIStaticText *m_guitext_status = nullptr;
 120         std::wstring m_statustext;
 121         float m_statustext_time = 0.0f;
 122         video::SColor m_statustext_initial_color;
 123
 124         gui::IGUIStaticText *m_guitext_chat = nullptr; // Chat text
 125         u32 m_recent_chat_count = 0;
 126
 127         gui::IGUIStaticText *m_guitext_profiler = nullptr; // Profiler text
 128         u8 m_profiler_current_page = 0;
 129         const u8 m_profiler_max_page = 3;
 130
 131         // Default: "". If other than "": Empty show_formspec packets will only
 132         // close the formspec when the formname matches
 133         std::string m_formname;
 134         GUIFormSpecMenu *m_formspec = nullptr;
 135 };