src/client/gameui.cpp

   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 #include "gameui.h"
  22 #include <irrlicht_changes/static_text.h>
  23 #include <gettext.h>
  24 #include "gui/mainmenumanager.h"
  25 #include "gui/guiChatConsole.h"
  26 #include "util/pointedthing.h"
  27 #include "client.h"
  28 #include "clientmap.h"
  29 #include "fontengine.h"
  30 #include "nodedef.h"
  31 #include "profiler.h"
  32 #include "renderingengine.h"
  33 #include "version.h"
  34
  35 inline static const char *yawToDirectionString(int yaw)
  36 {
  37         static const char *direction[4] =
  38                 {"North +Z", "West -X", "South -Z", "East +X"};
  39
  40         yaw = wrapDegrees_0_360(yaw);
  41         yaw = (yaw + 45) % 360 / 90;
  42
  43         return direction[yaw];
  44 }
  45
  46 GameUI::GameUI()
  47 {
  48         if (guienv && guienv->getSkin())
  49                 m_statustext_initial_color = guienv->getSkin()->getColor(gui::EGDC_BUTTON_TEXT);
  50         else
  51                 m_statustext_initial_color = video::SColor(255, 0, 0, 0);
  52
  53 }
  54 void GameUI::init()
  55 {
  56         // First line of debug text
  57         m_guitext = gui::StaticText::add(guienv, utf8_to_wide(PROJECT_NAME_C).c_str(),
  58                 core::rect<s32>(0, 0, 0, 0), false, true, guiroot);
  59
  60         // Second line of debug text
  61         m_guitext2 = gui::StaticText::add(guienv, L"", core::rect<s32>(0, 0, 0, 0), false,
  62                 true, guiroot);
  63
  64         // Chat text
  65         m_guitext_chat = gui::StaticText::add(guienv, L"", core::rect<s32>(0, 0, 0, 0),
  66                 //false, false); // Disable word wrap as of now
  67                 false, true, guiroot);
  68         u16 chat_font_size = g_settings->getU16("chat_font_size");
  69         if (chat_font_size != 0) {
  70                 m_guitext_chat->setOverrideFont(g_fontengine->getFont(
  71                         rangelim(chat_font_size, 5, 72), FM_Unspecified));
  72         }
  73
  74
  75         // Infotext of nodes and objects.
  76         // If in debug mode, object debug infos shown here, too.
  77         // Located on the left on the screen, below chat.
  78         u32 chat_font_height = m_guitext_chat->getActiveFont()->getDimension(L"Ay").Height;
  79         m_guitext_info = gui::StaticText::add(guienv, L"",
  80                 // Size is limited; text will be truncated after 6 lines.
  81                 core::rect<s32>(0, 0, 400, g_fontengine->getTextHeight() * 6) +
  82                         v2s32(100, chat_font_height *
  83                         (g_settings->getU16("recent_chat_messages") + 3)),
  84                         false, true, guiroot);
  85
  86         // Status text (displays info when showing and hiding GUI stuff, etc.)
  87         m_guitext_status = gui::StaticText::add(guienv, L"<Status>",
  88                 core::rect<s32>(0, 0, 0, 0), false, false, guiroot);
  89         m_guitext_status->setVisible(false);
  90
  91         // Profiler text (size is updated when text is updated)
  92         m_guitext_profiler = gui::StaticText::add(guienv, L"<Profiler>",
  93                 core::rect<s32>(0, 0, 0, 0), false, false, guiroot);
  94         m_guitext_profiler->setOverrideFont(g_fontengine->getFont(
  95                 g_fontengine->getDefaultFontSize() * 0.9f, FM_Mono));
  96         m_guitext_profiler->setVisible(false);
  97 }
  98
  99 void GameUI::update(const RunStats &stats, Client *client, MapDrawControl *draw_control,
 100         const CameraOrientation &cam, const PointedThing &pointed_old,
 101         const GUIChatConsole *chat_console, float dtime)
 102 {
 103         v2u32 screensize = RenderingEngine::getWindowSize();
 104
 105         s32 minimal_debug_height = 0;
 106
 107         // Minimal debug text must only contain info that can't give a gameplay advantage
 108         if (m_flags.show_minimal_debug) {
 109                 const u16 fps = 1.0 / stats.dtime_jitter.avg;
 110                 m_drawtime_avg *= 0.95f;
 111                 m_drawtime_avg += 0.05f * (stats.drawtime / 1000);
 112
 113                 std::ostringstream os(std::ios_base::binary);
 114                 os << std::fixed
 115                         << PROJECT_NAME_C " " << g_version_hash
 116                         << " | FPS: " << fps
 117                         << std::setprecision(0)
 118                         << " | drawtime: " << m_drawtime_avg << "ms"
 119                         << std::setprecision(1)
 120                         << " | dtime jitter: "
 121                         << (stats.dtime_jitter.max_fraction * 100.0) << "%"
 122                         << std::setprecision(1)
 123                         << " | view range: "
 124                         << (draw_control->range_all ? "All" : itos(draw_control->wanted_range))
 125                         << std::setprecision(2)
 126                         << " | RTT: " << (client->getRTT() * 1000.0f) << "ms";
 127
 128                 m_guitext->setRelativePosition(core::rect<s32>(5, 5, screensize.X, screensize.Y));
 129
 130                 setStaticText(m_guitext, utf8_to_wide(os.str()).c_str());
 131
 132                 minimal_debug_height = m_guitext->getTextHeight();
 133         }
 134
 135         // Finally set the guitext visible depending on the flag
 136         m_guitext->setVisible(m_flags.show_minimal_debug);
 137
 138         // Basic debug text also shows info that might give a gameplay advantage
 139         if (m_flags.show_basic_debug) {
 140                 LocalPlayer *player = client->getEnv().getLocalPlayer();
 141                 v3f player_position = player->getPosition();
 142
 143                 std::ostringstream os(std::ios_base::binary);
 144                 os << std::setprecision(1) << std::fixed
 145                         << "pos: (" << (player_position.X / BS)
 146                         << ", " << (player_position.Y / BS)
 147                         << ", " << (player_position.Z / BS)
 148                         << ") | yaw: " << (wrapDegrees_0_360(cam.camera_yaw)) << "° "
 149                         << yawToDirectionString(cam.camera_yaw)
 150                         << " | pitch: " << (-wrapDegrees_180(cam.camera_pitch)) << "°"
 151                         << " | seed: " << ((u64)client->getMapSeed());
 152
 153                 if (pointed_old.type == POINTEDTHING_NODE) {
 154                         ClientMap &map = client->getEnv().getClientMap();
 155                         const NodeDefManager *nodedef = client->getNodeDefManager();
 156                         MapNode n = map.getNode(pointed_old.node_undersurface);
 157
 158                         if (n.getContent() != CONTENT_IGNORE) {
 159                                 if (nodedef->get(n).name == "unknown") {
 160                                         os << ", pointed: <unknown node>";
 161                                 } else {
 162                                         os << ", pointed: " << nodedef->get(n).name;
 163                                 }
 164                                 os << ", param2: " << (u64) n.getParam2();
 165                         }
 166                 }
 167
 168                 m_guitext2->setRelativePosition(core::rect<s32>(5, 5 + minimal_debug_height,
 169                                 screensize.X, screensize.Y));
 170
 171                 setStaticText(m_guitext2, utf8_to_wide(os.str()).c_str());
 172         }
 173
 174         m_guitext2->setVisible(m_flags.show_basic_debug);
 175
 176         setStaticText(m_guitext_info, m_infotext.c_str());
 177         m_guitext_info->setVisible(m_flags.show_hud && g_menumgr.menuCount() == 0);
 178
 179         static const float statustext_time_max = 1.5f;
 180
 181         if (!m_statustext.empty()) {
 182                 m_statustext_time += dtime;
 183
 184                 if (m_statustext_time >= statustext_time_max) {
 185                         clearStatusText();
 186                         m_statustext_time = 0.0f;
 187                 }
 188         }
 189
 190         setStaticText(m_guitext_status, m_statustext.c_str());
 191         m_guitext_status->setVisible(!m_statustext.empty());
 192
 193         if (!m_statustext.empty()) {
 194                 s32 status_width  = m_guitext_status->getTextWidth();
 195                 s32 status_height = m_guitext_status->getTextHeight();
 196                 s32 status_y = screensize.Y - 150;
 197                 s32 status_x = (screensize.X - status_width) / 2;
 198
 199                 m_guitext_status->setRelativePosition(core::rect<s32>(status_x ,
 200                         status_y - status_height, status_x + status_width, status_y));
 201
 202                 // Fade out
 203                 video::SColor final_color = m_statustext_initial_color;
 204                 final_color.setAlpha(0);
 205                 video::SColor fade_color = m_statustext_initial_color.getInterpolated_quadratic(
 206                         m_statustext_initial_color, final_color, m_statustext_time / statustext_time_max);
 207                 m_guitext_status->setOverrideColor(fade_color);
 208                 m_guitext_status->enableOverrideColor(true);
 209         }
 210
 211         // Hide chat when console is visible
 212         m_guitext_chat->setVisible(isChatVisible() && !chat_console->isVisible());
 213 }
 214
 215 void GameUI::initFlags()
 216 {
 217         m_flags = GameUI::Flags();
 218         m_flags.show_minimal_debug = g_settings->getBool("show_debug");
 219 }
 220
 221 void GameUI::showMinimap(bool show)
 222 {
 223         m_flags.show_minimap = show;
 224 }
 225
 226 void GameUI::showTranslatedStatusText(const char *str)
 227 {
 228         const wchar_t *wmsg = wgettext(str);
 229         showStatusText(wmsg);
 230         delete[] wmsg;
 231 }
 232
 233 void GameUI::setChatText(const EnrichedString &chat_text, u32 recent_chat_count)
 234 {
 235         setStaticText(m_guitext_chat, chat_text);
 236
 237         m_recent_chat_count = recent_chat_count;
 238 }
 239
 240 void GameUI::updateChatSize()
 241 {
 242         // Update gui element size and position
 243         s32 chat_y = 5;
 244
 245         if (m_flags.show_minimal_debug)
 246                 chat_y += m_guitext->getTextHeight();
 247         if (m_flags.show_basic_debug)
 248                 chat_y += m_guitext2->getTextHeight();
 249
 250         const v2u32 &window_size = RenderingEngine::getWindowSize();
 251
 252         core::rect<s32> chat_size(10, chat_y, window_size.X - 20, 0);
 253         chat_size.LowerRightCorner.Y = std::min((s32)window_size.Y,
 254                         m_guitext_chat->getTextHeight() + chat_y);
 255
 256         if (chat_size == m_current_chat_size)
 257                 return;
 258         m_current_chat_size = chat_size;
 259
 260         m_guitext_chat->setRelativePosition(chat_size);
 261 }
 262
 263 void GameUI::updateProfiler()
 264 {
 265         if (m_profiler_current_page != 0) {
 266                 std::ostringstream os(std::ios_base::binary);
 267                 os << "   Profiler page " << (int)m_profiler_current_page <<
 268                                 ", elapsed: " << g_profiler->getElapsedMs() << " ms)" << std::endl;
 269
 270                 int lines = g_profiler->print(os, m_profiler_current_page, m_profiler_max_page);
 271                 ++lines;
 272
 273                 EnrichedString str(utf8_to_wide(os.str()));
 274                 str.setBackground(video::SColor(120, 0, 0, 0));
 275                 setStaticText(m_guitext_profiler, str);
 276
 277                 core::dimension2d<u32> size = m_guitext_profiler->getOverrideFont()->
 278                                 getDimension(str.c_str());
 279                 core::position2di upper_left(6, m_guitext->getTextHeight() * 2.5f);
 280                 core::position2di lower_right = upper_left;
 281                 lower_right.X += size.Width + 10;
 282                 lower_right.Y += size.Height;
 283
 284                 m_guitext_profiler->setRelativePosition(core::rect<s32>(upper_left, lower_right));
 285         }
 286
 287         m_guitext_profiler->setVisible(m_profiler_current_page != 0);
 288 }
 289
 290 void GameUI::toggleChat()
 291 {
 292         m_flags.show_chat = !m_flags.show_chat;
 293         if (m_flags.show_chat)
 294                 showTranslatedStatusText("Chat shown");
 295         else
 296                 showTranslatedStatusText("Chat hidden");
 297 }
 298
 299 void GameUI::toggleHud()
 300 {
 301         m_flags.show_hud = !m_flags.show_hud;
 302         if (m_flags.show_hud)
 303                 showTranslatedStatusText("HUD shown");
 304         else
 305                 showTranslatedStatusText("HUD hidden");
 306 }
 307
 308 void GameUI::toggleProfiler()
 309 {
 310         m_profiler_current_page = (m_profiler_current_page + 1) % (m_profiler_max_page + 1);
 311
 312         // FIXME: This updates the profiler with incomplete values
 313         updateProfiler();
 314
 315         if (m_profiler_current_page != 0) {
 316                 std::wstring msg = fwgettext("Profiler shown (page %d of %d)",
 317                                 m_profiler_current_page, m_profiler_max_page);
 318                 showStatusText(msg);
 319         } else {
 320                 showTranslatedStatusText("Profiler hidden");
 321         }
 322 }
 323
 324
 325 void GameUI::deleteFormspec()
 326 {
 327         if (m_formspec) {
 328                 m_formspec->drop();
 329                 m_formspec = nullptr;
 330         }
 331
 332         m_formname.clear();
 333 }