src/client/game.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #pragma once
  21
  22 #include <iomanip>
  23 #include <cmath>
  24 #include "client/renderingengine.h"
  25 #include "camera.h"
  26 #include "client.h"
  27 #include "client/clientevent.h"
  28 //#include "client/gameui.h"
  29 #include "client/inputhandler.h"
  30 #include "client/sound.h"
  31 #include "client/tile.h"     // For TextureSource
  32 #include "client/keys.h"
  33 #include "client/joystick_controller.h"
  34 #include "clientmap.h"
  35 #include "clouds.h"
  36 #include "config.h"
  37 #include "content_cao.h"
  38 #include "client/event_manager.h"
  39 #include "fontengine.h"
  40 #include "itemdef.h"
  41 #include "log.h"
  42 #include "filesys.h"
  43 #include "gettext.h"
  44 #include "gui/cheatMenu.h"
  45 #include "gui/guiChatConsole.h"
  46 #include "gui/guiConfirmRegistration.h"
  47 #include "gui/guiFormSpecMenu.h"
  48 #include "gui/guiKeyChangeMenu.h"
  49 #include "gui/guiPasswordChange.h"
  50 #include "gui/guiVolumeChange.h"
  51 #include "gui/mainmenumanager.h"
  52 #include "gui/profilergraph.h"
  53 #include "mapblock.h"
  54 #include "minimap.h"
  55 #include "nodedef.h"         // Needed for determining pointing to nodes
  56 #include "nodemetadata.h"
  57 #include "particles.h"
  58 #include "porting.h"
  59 #include "profiler.h"
  60 #include "raycast.h"
  61 #include "server.h"
  62 #include "settings.h"
  63 #include "shader.h"
  64 #include "sky.h"
  65 #include "translation.h"
  66 #include "util/basic_macros.h"
  67 #include "util/directiontables.h"
  68 #include "util/pointedthing.h"
  69 #include "util/quicktune_shortcutter.h"
  70 #include "irrlicht_changes/static_text.h"
  71 #include "version.h"
  72 #include "script/scripting_client.h"
  73 #include "hud.h"
  74 #include "irrlichttypes.h"
  75 #include <string>
  76
  77 class InputHandler;
  78 class ChatBackend;  /* to avoid having to include chat.h */
  79 struct SubgameSpec;
  80 struct GameStartData;
  81
  82 struct Jitter {
  83         f32 max, min, avg, counter, max_sample, min_sample, max_fraction;
  84 };
  85
  86 struct RunStats {
  87         u32 drawtime;
  88
  89         Jitter dtime_jitter, busy_time_jitter;
  90 };
  91
  92 struct CameraOrientation {
  93         f32 camera_yaw;    // "right/left"
  94         f32 camera_pitch;  // "up/down"
  95 };
  96
  97 /*
  98         Text input system
  99 */
 100
 101 struct TextDestNodeMetadata : public TextDest
 102 {
 103         TextDestNodeMetadata(v3s16 p, Client *client)
 104         {
 105                 m_p = p;
 106                 m_client = client;
 107         }
 108         // This is deprecated I guess? -celeron55
 109         void gotText(const std::wstring &text)
 110         {
 111                 std::string ntext = wide_to_utf8(text);
 112                 infostream << "Submitting 'text' field of node at (" << m_p.X << ","
 113                            << m_p.Y << "," << m_p.Z << "): " << ntext << std::endl;
 114                 StringMap fields;
 115                 fields["text"] = ntext;
 116                 m_client->sendNodemetaFields(m_p, "", fields);
 117         }
 118         void gotText(const StringMap &fields)
 119         {
 120                 m_client->sendNodemetaFields(m_p, "", fields);
 121         }
 122
 123         v3s16 m_p;
 124         Client *m_client;
 125 };
 126
 127 struct TextDestPlayerInventory : public TextDest
 128 {
 129         TextDestPlayerInventory(Client *client)
 130         {
 131                 m_client = client;
 132                 m_formname = "";
 133         }
 134         TextDestPlayerInventory(Client *client, const std::string &formname)
 135         {
 136                 m_client = client;
 137                 m_formname = formname;
 138         }
 139         void gotText(const StringMap &fields)
 140         {
 141                 m_client->sendInventoryFields(m_formname, fields);
 142         }
 143
 144         Client *m_client;
 145 };
 146
 147 struct LocalFormspecHandler : public TextDest
 148 {
 149         LocalFormspecHandler(const std::string &formname)
 150         {
 151                 m_formname = formname;
 152         }
 153
 154         LocalFormspecHandler(const std::string &formname, Client *client):
 155                 m_client(client)
 156         {
 157                 m_formname = formname;
 158         }
 159
 160         void gotText(const StringMap &fields)
 161         {
 162                 if (m_formname == "MT_PAUSE_MENU") {
 163                         if (fields.find("btn_sound") != fields.end()) {
 164                                 g_gamecallback->changeVolume();
 165                                 return;
 166                         }
 167
 168                         if (fields.find("btn_key_config") != fields.end()) {
 169                                 g_gamecallback->keyConfig();
 170                                 return;
 171                         }
 172
 173                         if (fields.find("btn_exit_menu") != fields.end()) {
 174                                 g_gamecallback->disconnect();
 175                                 return;
 176                         }
 177
 178                         if (fields.find("btn_exit_os") != fields.end()) {
 179                                 g_gamecallback->exitToOS();
 180 #ifndef __ANDROID__
 181                                 RenderingEngine::get_raw_device()->closeDevice();
 182 #endif
 183                                 return;
 184                         }
 185
 186                         if (fields.find("btn_change_password") != fields.end()) {
 187                                 g_gamecallback->changePassword();
 188                                 return;
 189                         }
 190
 191                         if (fields.find("quit") != fields.end()) {
 192                                 return;
 193                         }
 194
 195                         if (fields.find("btn_continue") != fields.end()) {
 196                                 return;
 197                         }
 198                 }
 199
 200                 if (m_formname == "MT_DEATH_SCREEN") {
 201                         assert(m_client != 0);
 202                         m_client->sendRespawn();
 203                         return;
 204                 }
 205
 206                 if (m_client->modsLoaded())
 207                         m_client->getScript()->on_formspec_input(m_formname, fields);
 208         }
 209
 210         Client *m_client = nullptr;
 211 };
 212
 213 /* Form update callback */
 214
 215 class NodeMetadataFormSource: public IFormSource
 216 {
 217 public:
 218         NodeMetadataFormSource(ClientMap *map, v3s16 p):
 219                 m_map(map),
 220                 m_p(p)
 221         {
 222         }
 223         const std::string &getForm() const
 224         {
 225                 static const std::string empty_string = "";
 226                 NodeMetadata *meta = m_map->getNodeMetadata(m_p);
 227
 228                 if (!meta)
 229                         return empty_string;
 230
 231                 return meta->getString("formspec");
 232         }
 233
 234         virtual std::string resolveText(const std::string &str)
 235         {
 236                 NodeMetadata *meta = m_map->getNodeMetadata(m_p);
 237
 238                 if (!meta)
 239                         return str;
 240
 241                 return meta->resolveString(str);
 242         }
 243
 244         ClientMap *m_map;
 245         v3s16 m_p;
 246 };
 247
 248 class PlayerInventoryFormSource: public IFormSource
 249 {
 250 public:
 251         PlayerInventoryFormSource(Client *client):
 252                 m_client(client)
 253         {
 254         }
 255
 256         const std::string &getForm() const
 257         {
 258                 LocalPlayer *player = m_client->getEnv().getLocalPlayer();
 259                 return player->inventory_formspec;
 260         }
 261
 262         Client *m_client;
 263 };
 264
 265 class NodeDugEvent: public MtEvent
 266 {
 267 public:
 268         v3s16 p;
 269         MapNode n;
 270
 271         NodeDugEvent(v3s16 p, MapNode n):
 272                 p(p),
 273                 n(n)
 274         {}
 275         MtEvent::Type getType() const
 276         {
 277                 return MtEvent::NODE_DUG;
 278         }
 279 };
 280
 281 class SoundMaker
 282 {
 283         ISoundManager *m_sound;
 284         const NodeDefManager *m_ndef;
 285 public:
 286         bool makes_footstep_sound;
 287         float m_player_step_timer;
 288         float m_player_jump_timer;
 289
 290         SimpleSoundSpec m_player_step_sound;
 291         SimpleSoundSpec m_player_leftpunch_sound;
 292         SimpleSoundSpec m_player_rightpunch_sound;
 293
 294         SoundMaker(ISoundManager *sound, const NodeDefManager *ndef):
 295                 m_sound(sound),
 296                 m_ndef(ndef),
 297                 makes_footstep_sound(true),
 298                 m_player_step_timer(0.0f),
 299                 m_player_jump_timer(0.0f)
 300         {
 301         }
 302
 303         void playPlayerStep()
 304         {
 305                 if (m_player_step_timer <= 0 && m_player_step_sound.exists()) {
 306                         m_player_step_timer = 0.03;
 307                         if (makes_footstep_sound)
 308                                 m_sound->playSound(m_player_step_sound, false);
 309                 }
 310         }
 311
 312         void playPlayerJump()
 313         {
 314                 if (m_player_jump_timer <= 0.0f) {
 315                         m_player_jump_timer = 0.2f;
 316                         m_sound->playSound(SimpleSoundSpec("player_jump", 0.5f), false);
 317                 }
 318         }
 319
 320         static void viewBobbingStep(MtEvent *e, void *data)
 321         {
 322                 SoundMaker *sm = (SoundMaker *)data;
 323                 sm->playPlayerStep();
 324         }
 325
 326         static void playerRegainGround(MtEvent *e, void *data)
 327         {
 328                 SoundMaker *sm = (SoundMaker *)data;
 329                 sm->playPlayerStep();
 330         }
 331
 332         static void playerJump(MtEvent *e, void *data)
 333         {
 334                 SoundMaker *sm = (SoundMaker *)data;
 335                 sm->playPlayerJump();
 336         }
 337
 338         static void cameraPunchLeft(MtEvent *e, void *data)
 339         {
 340                 SoundMaker *sm = (SoundMaker *)data;
 341                 sm->m_sound->playSound(sm->m_player_leftpunch_sound, false);
 342         }
 343
 344         static void cameraPunchRight(MtEvent *e, void *data)
 345         {
 346                 SoundMaker *sm = (SoundMaker *)data;
 347                 sm->m_sound->playSound(sm->m_player_rightpunch_sound, false);
 348         }
 349
 350         static void nodeDug(MtEvent *e, void *data)
 351         {
 352                 SoundMaker *sm = (SoundMaker *)data;
 353                 NodeDugEvent *nde = (NodeDugEvent *)e;
 354                 sm->m_sound->playSound(sm->m_ndef->get(nde->n).sound_dug, false);
 355         }
 356
 357         static void playerDamage(MtEvent *e, void *data)
 358         {
 359                 SoundMaker *sm = (SoundMaker *)data;
 360                 sm->m_sound->playSound(SimpleSoundSpec("player_damage", 0.5), false);
 361         }
 362
 363         static void playerFallingDamage(MtEvent *e, void *data)
 364         {
 365                 SoundMaker *sm = (SoundMaker *)data;
 366                 sm->m_sound->playSound(SimpleSoundSpec("player_falling_damage", 0.5), false);
 367         }
 368
 369         void registerReceiver(MtEventManager *mgr)
 370         {
 371                 mgr->reg(MtEvent::VIEW_BOBBING_STEP, SoundMaker::viewBobbingStep, this);
 372                 mgr->reg(MtEvent::PLAYER_REGAIN_GROUND, SoundMaker::playerRegainGround, this);
 373                 mgr->reg(MtEvent::PLAYER_JUMP, SoundMaker::playerJump, this);
 374                 mgr->reg(MtEvent::CAMERA_PUNCH_LEFT, SoundMaker::cameraPunchLeft, this);
 375                 mgr->reg(MtEvent::CAMERA_PUNCH_RIGHT, SoundMaker::cameraPunchRight, this);
 376                 mgr->reg(MtEvent::NODE_DUG, SoundMaker::nodeDug, this);
 377                 mgr->reg(MtEvent::PLAYER_DAMAGE, SoundMaker::playerDamage, this);
 378                 mgr->reg(MtEvent::PLAYER_FALLING_DAMAGE, SoundMaker::playerFallingDamage, this);
 379         }
 380
 381         void step(float dtime)
 382         {
 383                 m_player_step_timer -= dtime;
 384                 m_player_jump_timer -= dtime;
 385         }
 386 };
 387
 388 // Locally stored sounds don't need to be preloaded because of this
 389 class GameOnDemandSoundFetcher: public OnDemandSoundFetcher
 390 {
 391         std::set<std::string> m_fetched;
 392 private:
 393         void paths_insert(std::set<std::string> &dst_paths,
 394                 const std::string &base,
 395                 const std::string &name)
 396         {
 397                 dst_paths.insert(base + DIR_DELIM + "sounds" + DIR_DELIM + name + ".ogg");
 398                 dst_paths.insert(base + DIR_DELIM + "sounds" + DIR_DELIM + name + ".0.ogg");
 399                 dst_paths.insert(base + DIR_DELIM + "sounds" + DIR_DELIM + name + ".1.ogg");
 400                 dst_paths.insert(base + DIR_DELIM + "sounds" + DIR_DELIM + name + ".2.ogg");
 401                 dst_paths.insert(base + DIR_DELIM + "sounds" + DIR_DELIM + name + ".3.ogg");
 402                 dst_paths.insert(base + DIR_DELIM + "sounds" + DIR_DELIM + name + ".4.ogg");
 403                 dst_paths.insert(base + DIR_DELIM + "sounds" + DIR_DELIM + name + ".5.ogg");
 404                 dst_paths.insert(base + DIR_DELIM + "sounds" + DIR_DELIM + name + ".6.ogg");
 405                 dst_paths.insert(base + DIR_DELIM + "sounds" + DIR_DELIM + name + ".7.ogg");
 406                 dst_paths.insert(base + DIR_DELIM + "sounds" + DIR_DELIM + name + ".8.ogg");
 407                 dst_paths.insert(base + DIR_DELIM + "sounds" + DIR_DELIM + name + ".9.ogg");
 408         }
 409 public:
 410         void fetchSounds(const std::string &name,
 411                 std::set<std::string> &dst_paths,
 412                 std::set<std::string> &dst_datas)
 413         {
 414                 if (m_fetched.count(name))
 415                         return;
 416
 417                 m_fetched.insert(name);
 418
 419                 paths_insert(dst_paths, porting::path_share, name);
 420                 paths_insert(dst_paths, porting::path_user,  name);
 421         }
 422 };
 423
 424
 425 // before 1.8 there isn't a "integer interface", only float
 426 #if (IRRLICHT_VERSION_MAJOR == 1 && IRRLICHT_VERSION_MINOR < 8)
 427 typedef f32 SamplerLayer_t;
 428 #else
 429 typedef s32 SamplerLayer_t;
 430 #endif
 431
 432
 433 class GameGlobalShaderConstantSetter : public IShaderConstantSetter
 434 {
 435         Sky *m_sky;
 436         bool *m_force_fog_off;
 437         f32 *m_fog_range;
 438         bool m_fog_enabled;
 439         CachedPixelShaderSetting<float, 4> m_sky_bg_color;
 440         CachedPixelShaderSetting<float> m_fog_distance;
 441         CachedVertexShaderSetting<float> m_animation_timer_vertex;
 442         CachedPixelShaderSetting<float> m_animation_timer_pixel;
 443         CachedPixelShaderSetting<float, 3> m_day_light;
 444         CachedPixelShaderSetting<float, 4> m_star_color;
 445         CachedPixelShaderSetting<float, 3> m_eye_position_pixel;
 446         CachedVertexShaderSetting<float, 3> m_eye_position_vertex;
 447         CachedPixelShaderSetting<float, 3> m_minimap_yaw;
 448         CachedPixelShaderSetting<float, 3> m_camera_offset_pixel;
 449         CachedPixelShaderSetting<float, 3> m_camera_offset_vertex;
 450         CachedPixelShaderSetting<SamplerLayer_t> m_base_texture;
 451         Client *m_client;
 452
 453 public:
 454         void onSettingsChange(const std::string &name)
 455         {
 456                 if (name == "enable_fog")
 457                         m_fog_enabled = g_settings->getBool("enable_fog");
 458         }
 459
 460         static void settingsCallback(const std::string &name, void *userdata)
 461         {
 462                 reinterpret_cast<GameGlobalShaderConstantSetter*>(userdata)->onSettingsChange(name);
 463         }
 464
 465         void setSky(Sky *sky) { m_sky = sky; }
 466
 467         GameGlobalShaderConstantSetter(Sky *sky, bool *force_fog_off,
 468                         f32 *fog_range, Client *client) :
 469                 m_sky(sky),
 470                 m_force_fog_off(force_fog_off),
 471                 m_fog_range(fog_range),
 472                 m_sky_bg_color("skyBgColor"),
 473                 m_fog_distance("fogDistance"),
 474                 m_animation_timer_vertex("animationTimer"),
 475                 m_animation_timer_pixel("animationTimer"),
 476                 m_day_light("dayLight"),
 477                 m_star_color("starColor"),
 478                 m_eye_position_pixel("eyePosition"),
 479                 m_eye_position_vertex("eyePosition"),
 480                 m_minimap_yaw("yawVec"),
 481                 m_camera_offset_pixel("cameraOffset"),
 482                 m_camera_offset_vertex("cameraOffset"),
 483                 m_base_texture("baseTexture"),
 484                 m_client(client)
 485         {
 486                 g_settings->registerChangedCallback("enable_fog", settingsCallback, this);
 487                 m_fog_enabled = g_settings->getBool("enable_fog");
 488         }
 489
 490         ~GameGlobalShaderConstantSetter()
 491         {
 492                 g_settings->deregisterChangedCallback("enable_fog", settingsCallback, this);
 493         }
 494
 495         void onSetConstants(video::IMaterialRendererServices *services) override
 496         {
 497                 // Background color
 498                 video::SColor bgcolor = m_sky->getBgColor();
 499                 video::SColorf bgcolorf(bgcolor);
 500                 float bgcolorfa[4] = {
 501                         bgcolorf.r,
 502                         bgcolorf.g,
 503                         bgcolorf.b,
 504                         bgcolorf.a,
 505                 };
 506                 m_sky_bg_color.set(bgcolorfa, services);
 507
 508                 // Fog distance
 509                 float fog_distance = 10000 * BS;
 510
 511                 if (m_fog_enabled && !*m_force_fog_off)
 512                         fog_distance = *m_fog_range;
 513
 514                 m_fog_distance.set(&fog_distance, services);
 515
 516                 u32 daynight_ratio = (float)m_client->getEnv().getDayNightRatio();
 517                 video::SColorf sunlight;
 518                 get_sunlight_color(&sunlight, daynight_ratio);
 519                 float dnc[3] = {
 520                         sunlight.r,
 521                         sunlight.g,
 522                         sunlight.b };
 523                 m_day_light.set(dnc, services);
 524
 525                 video::SColorf star_color = m_sky->getCurrentStarColor();
 526                 float clr[4] = {star_color.r, star_color.g, star_color.b, star_color.a};
 527                 m_star_color.set(clr, services);
 528
 529                 u32 animation_timer = porting::getTimeMs() % 1000000;
 530                 float animation_timer_f = (float)animation_timer / 100000.f;
 531                 m_animation_timer_vertex.set(&animation_timer_f, services);
 532                 m_animation_timer_pixel.set(&animation_timer_f, services);
 533
 534                 float eye_position_array[3];
 535                 v3f epos = m_client->getEnv().getLocalPlayer()->getEyePosition();
 536 #if (IRRLICHT_VERSION_MAJOR == 1 && IRRLICHT_VERSION_MINOR < 8)
 537                 eye_position_array[0] = epos.X;
 538                 eye_position_array[1] = epos.Y;
 539                 eye_position_array[2] = epos.Z;
 540 #else
 541                 epos.getAs3Values(eye_position_array);
 542 #endif
 543                 m_eye_position_pixel.set(eye_position_array, services);
 544                 m_eye_position_vertex.set(eye_position_array, services);
 545
 546                 if (m_client->getMinimap()) {
 547                         float minimap_yaw_array[3];
 548                         v3f minimap_yaw = m_client->getMinimap()->getYawVec();
 549 #if (IRRLICHT_VERSION_MAJOR == 1 && IRRLICHT_VERSION_MINOR < 8)
 550                         minimap_yaw_array[0] = minimap_yaw.X;
 551                         minimap_yaw_array[1] = minimap_yaw.Y;
 552                         minimap_yaw_array[2] = minimap_yaw.Z;
 553 #else
 554                         minimap_yaw.getAs3Values(minimap_yaw_array);
 555 #endif
 556                         m_minimap_yaw.set(minimap_yaw_array, services);
 557                 }
 558
 559                 float camera_offset_array[3];
 560                 v3f offset = intToFloat(m_client->getCamera()->getOffset(), BS);
 561 #if (IRRLICHT_VERSION_MAJOR == 1 && IRRLICHT_VERSION_MINOR < 8)
 562                 camera_offset_array[0] = offset.X;
 563                 camera_offset_array[1] = offset.Y;
 564                 camera_offset_array[2] = offset.Z;
 565 #else
 566                 offset.getAs3Values(camera_offset_array);
 567 #endif
 568                 m_camera_offset_pixel.set(camera_offset_array, services);
 569                 m_camera_offset_vertex.set(camera_offset_array, services);
 570
 571                 SamplerLayer_t base_tex = 0;
 572                 m_base_texture.set(&base_tex, services);
 573         }
 574 };
 575
 576
 577 class GameGlobalShaderConstantSetterFactory : public IShaderConstantSetterFactory
 578 {
 579         Sky *m_sky;
 580         bool *m_force_fog_off;
 581         f32 *m_fog_range;
 582         Client *m_client;
 583         std::vector<GameGlobalShaderConstantSetter *> created_nosky;
 584 public:
 585         GameGlobalShaderConstantSetterFactory(bool *force_fog_off,
 586                         f32 *fog_range, Client *client) :
 587                 m_sky(NULL),
 588                 m_force_fog_off(force_fog_off),
 589                 m_fog_range(fog_range),
 590                 m_client(client)
 591         {}
 592
 593         void setSky(Sky *sky) {
 594                 m_sky = sky;
 595                 for (GameGlobalShaderConstantSetter *ggscs : created_nosky) {
 596                         ggscs->setSky(m_sky);
 597                 }
 598                 created_nosky.clear();
 599         }
 600
 601         virtual IShaderConstantSetter* create()
 602         {
 603                 auto *scs = new GameGlobalShaderConstantSetter(
 604                                 m_sky, m_force_fog_off, m_fog_range, m_client);
 605                 if (!m_sky)
 606                         created_nosky.push_back(scs);
 607                 return scs;
 608         }
 609 };
 610
 611 #ifdef __ANDROID__
 612 #define SIZE_TAG "size[11,5.5]"
 613 #else
 614 #define SIZE_TAG "size[11,5.5,true]" // Fixed size on desktop
 615 #endif
 616
 617 /****************************************************************************
 618  ****************************************************************************/
 619
 620 const float object_hit_delay = 0.2;
 621
 622 struct FpsControl {
 623         u32 last_time, busy_time, sleep_time;
 624 };
 625
 626
 627 /* The reason the following structs are not anonymous structs within the
 628  * class is that they are not used by the majority of member functions and
 629  * many functions that do require objects of thse types do not modify them
 630  * (so they can be passed as a const qualified parameter)
 631  */
 632
 633 struct GameRunData {
 634         u16 dig_index;
 635         u16 new_playeritem;
 636         PointedThing pointed_old;
 637         bool digging;
 638         bool punching;
 639         bool btn_down_for_dig;
 640         bool dig_instantly;
 641         bool digging_blocked;
 642         bool reset_jump_timer;
 643         float nodig_delay_timer;
 644         float dig_time;
 645         float dig_time_complete;
 646         float repeat_place_timer;
 647         float object_hit_delay_timer;
 648         float time_from_last_punch;
 649         ClientActiveObject *selected_object;
 650
 651         float jump_timer;
 652         float damage_flash;
 653         float update_draw_list_timer;
 654
 655         f32 fog_range;
 656
 657         v3f update_draw_list_last_cam_dir;
 658
 659         float time_of_day_smooth;
 660 };
 661
 662 class Game;
 663
 664 struct ClientEventHandler
 665 {
 666         void (Game::*handler)(ClientEvent *, CameraOrientation *);
 667 };
 668
 669 class Game {
 670 public:
 671         Game();
 672         ~Game();
 673
 674         bool startup(bool *kill,
 675                         InputHandler *input,
 676                         const GameStartData &game_params,
 677                         std::string &error_message,
 678                         bool *reconnect,
 679                         ChatBackend *chat_backend);
 680
 681
 682         void run();
 683         void shutdown();
 684
 685         void extendedResourceCleanup();
 686
 687         // Basic initialisation
 688         bool init(const std::string &map_dir, const std::string &address,
 689                         u16 port, const SubgameSpec &gamespec);
 690         bool initSound();
 691         bool createSingleplayerServer(const std::string &map_dir,
 692                         const SubgameSpec &gamespec, u16 port);
 693
 694         // Client creation
 695         bool createClient(const GameStartData &start_data);
 696         bool initGui();
 697
 698         // Client connection
 699         bool connectToServer(const GameStartData &start_data,
 700                         bool *connect_ok, bool *aborted);
 701         bool getServerContent(bool *aborted);
 702
 703         // Main loop
 704
 705         void updateInteractTimers(f32 dtime);
 706         bool checkConnection();
 707         bool handleCallbacks();
 708         void processQueues();
 709         void updateProfilers(const RunStats &stats, const FpsControl &draw_times, f32 dtime);
 710         void updateStats(RunStats *stats, const FpsControl &draw_times, f32 dtime);
 711         void updateProfilerGraphs(ProfilerGraph *graph);
 712
 713         // Input related
 714         void processUserInput(f32 dtime);
 715         void processKeyInput();
 716         void processItemSelection(u16 *new_playeritem);
 717
 718         void dropSelectedItem(bool single_item = false);
 719         void openInventory();
 720         void openEnderchest();
 721         void openConsole(float scale, const wchar_t *line=NULL);
 722         void toggleFreeMove();
 723         void toggleFreeMoveAlt();
 724         void togglePitchMove();
 725         void toggleFast();
 726         void toggleNoClip();
 727         void toggleKillaura();
 728         void toggleFreecam();
 729         void toggleScaffold();
 730         void toggleNextItem();
 731         void toggleCinematic();
 732         void toggleAutoforward();
 733
 734         void toggleMinimap(bool shift_pressed);
 735         void toggleFog();
 736         void toggleDebug();
 737         void toggleUpdateCamera();
 738         void updatePlayerCAOVisibility();
 739
 740         void increaseViewRange();
 741         void decreaseViewRange();
 742         void toggleFullViewRange();
 743         void checkZoomEnabled();
 744
 745         void updateCameraDirection(CameraOrientation *cam, float dtime);
 746         void updateCameraOrientation(CameraOrientation *cam, float dtime);
 747         void updatePlayerControl(const CameraOrientation &cam);
 748         void step(f32 *dtime);
 749         void processClientEvents(CameraOrientation *cam);
 750         void updateCamera(u32 busy_time, f32 dtime);
 751         void updateSound(f32 dtime);
 752         void processPlayerInteraction(f32 dtime, bool show_hud, bool show_debug);
 753         /*!
 754          * Returns the object or node the player is pointing at.
 755          * Also updates the selected thing in the Hud.
 756          *
 757          * @param[in]  shootline         the shootline, starting from
 758          * the camera position. This also gives the maximal distance
 759          * of the search.
 760          * @param[in]  liquids_pointable if false, liquids are ignored
 761          * @param[in]  look_for_object   if false, objects are ignored
 762          * @param[in]  camera_offset     offset of the camera
 763          * @param[out] selected_object   the selected object or
 764          * NULL if not found
 765          */
 766         PointedThing updatePointedThing(
 767                         const core::line3d<f32> &shootline, bool liquids_pointable,
 768                         bool look_for_object, const v3s16 &camera_offset);
 769         void handlePointingAtNothing(const ItemStack &playerItem);
 770         void handlePointingAtNode(const PointedThing &pointed,
 771                         const ItemStack &selected_item, const ItemStack &hand_item, f32 dtime);
 772         void handlePointingAtObject(const PointedThing &pointed, const ItemStack &playeritem,
 773                         const v3f &player_position, bool show_debug);
 774         void handleDigging(const PointedThing &pointed, const v3s16 &nodepos,
 775                         const ItemStack &selected_item, const ItemStack &hand_item, f32 dtime);
 776         void updateFrame(ProfilerGraph *graph, RunStats *stats, f32 dtime,
 777                         const CameraOrientation &cam);
 778
 779         // Misc
 780         void limitFps(FpsControl *fps_timings, f32 *dtime);
 781
 782         void showOverlayMessage(const char *msg, float dtime, int percent,
 783                         bool draw_clouds = true);
 784
 785         static void freecamChangedCallback(const std::string &setting_name, void *data);
 786         static void settingChangedCallback(const std::string &setting_name, void *data);
 787         static void updateAllMapBlocksCallback(const std::string &setting_name, void *data);
 788         void readSettings();
 789
 790         bool isKeyDown(GameKeyType k);
 791         bool wasKeyDown(GameKeyType k);
 792         bool wasKeyPressed(GameKeyType k);
 793         bool wasKeyReleased(GameKeyType k);
 794
 795 #ifdef __ANDROID__
 796         void handleAndroidChatInput();
 797 #endif
 798
 799         struct Flags {
 800                 bool force_fog_off = false;
 801                 bool disable_camera_update = false;
 802         };
 803
 804         void showDeathFormspec();
 805         void showPauseMenu();
 806
 807         // ClientEvent handlers
 808         void handleClientEvent_None(ClientEvent *event, CameraOrientation *cam);
 809         void handleClientEvent_PlayerDamage(ClientEvent *event, CameraOrientation *cam);
 810         void handleClientEvent_PlayerForceMove(ClientEvent *event, CameraOrientation *cam);
 811         void handleClientEvent_Deathscreen(ClientEvent *event, CameraOrientation *cam);
 812         void handleClientEvent_ShowFormSpec(ClientEvent *event, CameraOrientation *cam);
 813         void handleClientEvent_ShowLocalFormSpec(ClientEvent *event, CameraOrientation *cam);
 814         void handleClientEvent_HandleParticleEvent(ClientEvent *event,
 815                 CameraOrientation *cam);
 816         void handleClientEvent_HudAdd(ClientEvent *event, CameraOrientation *cam);
 817         void handleClientEvent_HudRemove(ClientEvent *event, CameraOrientation *cam);
 818         void handleClientEvent_HudChange(ClientEvent *event, CameraOrientation *cam);
 819         void handleClientEvent_SetSky(ClientEvent *event, CameraOrientation *cam);
 820         void handleClientEvent_SetSun(ClientEvent *event, CameraOrientation *cam);
 821         void handleClientEvent_SetMoon(ClientEvent *event, CameraOrientation *cam);
 822         void handleClientEvent_SetStars(ClientEvent *event, CameraOrientation *cam);
 823         void handleClientEvent_OverrideDayNigthRatio(ClientEvent *event,
 824                 CameraOrientation *cam);
 825         void handleClientEvent_CloudParams(ClientEvent *event, CameraOrientation *cam);
 826
 827         void updateChat(f32 dtime, const v2u32 &screensize);
 828
 829         bool nodePlacement(const ItemDefinition &selected_def, const ItemStack &selected_item,
 830                 const v3s16 &nodepos, const v3s16 &neighbourpos, const PointedThing &pointed,
 831                 const NodeMetadata *meta);
 832         static const ClientEventHandler clientEventHandler[CLIENTEVENT_MAX];
 833
 834         InputHandler *input = nullptr;
 835
 836         Client *client = nullptr;
 837         Server *server = nullptr;
 838
 839         IWritableTextureSource *texture_src = nullptr;
 840         IWritableShaderSource *shader_src = nullptr;
 841
 842         // When created, these will be filled with data received from the server
 843         IWritableItemDefManager *itemdef_manager = nullptr;
 844         NodeDefManager *nodedef_manager = nullptr;
 845
 846         GameOnDemandSoundFetcher soundfetcher; // useful when testing
 847         ISoundManager *sound = nullptr;
 848         bool sound_is_dummy = false;
 849         SoundMaker *soundmaker = nullptr;
 850
 851         ChatBackend *chat_backend = nullptr;
 852         LogOutputBuffer m_chat_log_buf;
 853
 854         EventManager *eventmgr = nullptr;
 855         QuicktuneShortcutter *quicktune = nullptr;
 856         bool registration_confirmation_shown = false;
 857
 858         std::unique_ptr<GameUI> m_game_ui;
 859         GUIChatConsole *gui_chat_console = nullptr; // Free using ->Drop()
 860         CheatMenu *m_cheat_menu = nullptr;
 861         MapDrawControl *draw_control = nullptr;
 862         Camera *camera = nullptr;
 863         Clouds *clouds = nullptr;                         // Free using ->Drop()
 864         Sky *sky = nullptr;                         // Free using ->Drop()
 865         Hud *hud = nullptr;
 866         Minimap *mapper = nullptr;
 867
 868         GameRunData runData;
 869         Flags m_flags;
 870
 871         /* 'cache'
 872            This class does take ownership/responsibily for cleaning up etc of any of
 873            these items (e.g. device)
 874         */
 875         IrrlichtDevice *device;
 876         video::IVideoDriver *driver;
 877         scene::ISceneManager *smgr;
 878         bool *kill;
 879         std::string *error_message;
 880         bool *reconnect_requested;
 881         scene::ISceneNode *skybox;
 882
 883         bool simple_singleplayer_mode;
 884         /* End 'cache' */
 885
 886         /* Pre-calculated values
 887          */
 888         int crack_animation_length;
 889
 890         IntervalLimiter profiler_interval;
 891
 892         /*
 893          * TODO: Local caching of settings is not optimal and should at some stage
 894          *       be updated to use a global settings object for getting thse values
 895          *       (as opposed to the this local caching). This can be addressed in
 896          *       a later release.
 897          */
 898         bool m_cache_doubletap_jump;
 899         bool m_cache_enable_clouds;
 900         bool m_cache_enable_joysticks;
 901         bool m_cache_enable_particles;
 902         bool m_cache_enable_fog;
 903         bool m_cache_enable_noclip;
 904         bool m_cache_enable_free_move;
 905         f32  m_cache_mouse_sensitivity;
 906         f32  m_cache_joystick_frustum_sensitivity;
 907         f32  m_repeat_place_time;
 908         f32  m_cache_cam_smoothing;
 909         f32  m_cache_fog_start;
 910
 911         bool m_invert_mouse = false;
 912         bool m_first_loop_after_window_activation = false;
 913         bool m_camera_offset_changed = false;
 914
 915         bool m_does_lost_focus_pause_game = false;
 916
 917         CameraOrientation cam_view_target  = { 0 };
 918         CameraOrientation cam_view  = { 0 };
 919
 920         int m_reset_HW_buffer_counter = 0;
 921 #ifdef __ANDROID__
 922         bool m_cache_hold_aux1;
 923         bool m_android_chat_open;
 924 #endif
 925 };
 926 extern Game *g_game;
 927
 928 void the_game(bool *kill,
 929                 InputHandler *input,
 930                 const GameStartData &start_data,
 931                 std::string &error_message,
 932                 ChatBackend &chat_backend,
 933                 bool *reconnect_requested);