3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
24 #include <IFileSystem.h>
25 #include "threading/mutex_auto_lock.h"
26 #include "util/auth.h"
27 #include "util/directiontables.h"
28 #include "util/pointedthing.h"
29 #include "util/serialize.h"
30 #include "util/string.h"
33 #include "network/clientopcodes.h"
35 #include "mapblock_mesh.h"
41 #include "clientmap.h"
42 #include "clientmedia.h"
44 #include "drawscene.h"
45 #include "database-sqlite3.h"
46 #include "serialization.h"
47 #include "guiscalingfilter.h"
48 #include "script/scripting_client.h"
51 extern gui::IGUIEnvironment* guienv;
58 IrrlichtDevice *device,
59 const char *playername,
60 const std::string &password,
61 MapDrawControl &control,
62 IWritableTextureSource *tsrc,
63 IWritableShaderSource *shsrc,
64 IWritableItemDefManager *itemdef,
65 IWritableNodeDefManager *nodedef,
67 MtEventManager *event,
69 GameUIFlags *game_ui_flags
71 m_packetcounter_timer(0.0),
72 m_connection_reinit_timer(0.1),
74 m_playerpos_send_timer(0.0),
75 m_ignore_damage_timer(0.0),
82 m_mesh_update_thread(this),
84 new ClientMap(this, control,
85 device->getSceneManager()->getRootSceneNode(),
86 device->getSceneManager(), 666),
87 device->getSceneManager(),
90 m_particle_manager(&m_env),
91 m_con(PROTOCOL_ID, 512, CONNECTION_TIMEOUT, ipv6, this),
94 m_minimap_disabled_by_server(false),
95 m_server_ser_ver(SER_FMT_VER_INVALID),
98 m_inventory_updated(false),
99 m_inventory_from_server(NULL),
100 m_inventory_from_server_age(0.0),
105 m_password(password),
106 m_chosen_auth_mech(AUTH_MECHANISM_NONE),
108 m_access_denied(false),
109 m_access_denied_reconnect(false),
110 m_itemdef_received(false),
111 m_nodedef_received(false),
112 m_media_downloader(new ClientMediaDownloader()),
113 m_time_of_day_set(false),
114 m_last_time_of_day_f(-1),
115 m_time_of_day_update_timer(0),
116 m_recommended_send_interval(0.1),
117 m_removed_sounds_check_timer(0),
121 m_mod_storage_save_timer(10.0f),
122 m_game_ui_flags(game_ui_flags),
126 m_env.setLocalPlayer(new LocalPlayer(this, playername));
128 m_minimap = new Minimap(device, this);
129 m_cache_save_interval = g_settings->getU16("server_map_save_interval");
131 m_modding_enabled = g_settings->getBool("enable_client_modding");
132 m_script = new ClientScripting(this);
133 m_env.setScript(m_script);
134 m_script->setEnv(&m_env);
137 void Client::initMods()
139 m_script->loadMod(getBuiltinLuaPath() + DIR_DELIM "init.lua", BUILTIN_MOD_NAME);
141 // If modding is not enabled, don't load mods, just builtin
142 if (!m_modding_enabled) {
146 ClientModConfiguration modconf(getClientModsLuaPath());
147 std::vector<ModSpec> mods = modconf.getMods();
148 std::vector<ModSpec> unsatisfied_mods = modconf.getUnsatisfiedMods();
149 // complain about mods with unsatisfied dependencies
150 if (!modconf.isConsistent()) {
151 modconf.printUnsatisfiedModsError();
155 infostream << "Client Loading mods: ";
156 for (std::vector<ModSpec>::const_iterator i = mods.begin();
157 i != mods.end(); ++i) {
158 infostream << (*i).name << " ";
161 infostream << std::endl;
162 // Load and run "mod" scripts
163 for (std::vector<ModSpec>::const_iterator it = mods.begin();
164 it != mods.end(); ++it) {
165 const ModSpec &mod = *it;
166 if (!string_allowed(mod.name, MODNAME_ALLOWED_CHARS)) {
167 throw ModError("Error loading mod \"" + mod.name +
168 "\": Mod name does not follow naming conventions: "
169 "Only chararacters [a-z0-9_] are allowed.");
171 std::string script_path = mod.path + DIR_DELIM + "init.lua";
172 infostream << " [" << padStringRight(mod.name, 12) << "] [\""
173 << script_path << "\"]" << std::endl;
174 m_script->loadMod(script_path, mod.name);
178 const std::string &Client::getBuiltinLuaPath()
180 static const std::string builtin_dir = porting::path_share + DIR_DELIM + "builtin";
184 const std::string &Client::getClientModsLuaPath()
186 static const std::string clientmods_dir = porting::path_share + DIR_DELIM + "clientmods";
187 return clientmods_dir;
190 const std::vector<ModSpec>& Client::getMods() const
192 static std::vector<ModSpec> client_modspec_temp;
193 return client_modspec_temp;
196 const ModSpec* Client::getModSpec(const std::string &modname) const
204 // Don't disable this part when modding is disabled, it's used in builtin
205 m_script->on_shutdown();
206 //request all client managed threads to stop
207 m_mesh_update_thread.stop();
208 // Save local server map
210 infostream << "Local map saving ended." << std::endl;
211 m_localdb->endSave();
217 bool Client::isShutdown()
219 return m_shutdown || !m_mesh_update_thread.isRunning();
227 m_mesh_update_thread.stop();
228 m_mesh_update_thread.wait();
229 while (!m_mesh_update_thread.m_queue_out.empty()) {
230 MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
235 delete m_inventory_from_server;
237 // Delete detached inventories
238 for (UNORDERED_MAP<std::string, Inventory*>::iterator
239 i = m_detached_inventories.begin();
240 i != m_detached_inventories.end(); ++i) {
244 // cleanup 3d model meshes on client shutdown
245 while (m_device->getSceneManager()->getMeshCache()->getMeshCount() != 0) {
246 scene::IAnimatedMesh *mesh =
247 m_device->getSceneManager()->getMeshCache()->getMeshByIndex(0);
250 m_device->getSceneManager()->getMeshCache()->removeMesh(mesh);
256 void Client::connect(Address address,
257 const std::string &address_name,
258 bool is_local_server)
260 DSTACK(FUNCTION_NAME);
262 initLocalMapSaving(address, address_name, is_local_server);
264 m_con.SetTimeoutMs(0);
265 m_con.Connect(address);
268 void Client::step(float dtime)
270 DSTACK(FUNCTION_NAME);
276 if(m_ignore_damage_timer > dtime)
277 m_ignore_damage_timer -= dtime;
279 m_ignore_damage_timer = 0.0;
281 m_animation_time += dtime;
282 if(m_animation_time > 60.0)
283 m_animation_time -= 60.0;
285 m_time_of_day_update_timer += dtime;
293 float &counter = m_packetcounter_timer;
299 infostream << "Client packetcounter (" << m_packetcounter_timer
301 m_packetcounter.print(infostream);
302 m_packetcounter.clear();
306 // UGLY hack to fix 2 second startup delay caused by non existent
307 // server client startup synchronization in local server or singleplayer mode
308 static bool initial_step = true;
310 initial_step = false;
312 else if(m_state == LC_Created) {
313 float &counter = m_connection_reinit_timer;
318 LocalPlayer *myplayer = m_env.getLocalPlayer();
319 FATAL_ERROR_IF(myplayer == NULL, "Local player not found in environment.");
321 u16 proto_version_min = g_settings->getFlag("send_pre_v25_init") ?
322 CLIENT_PROTOCOL_VERSION_MIN_LEGACY : CLIENT_PROTOCOL_VERSION_MIN;
324 if (proto_version_min < 25) {
325 // Send TOSERVER_INIT_LEGACY
326 // [0] u16 TOSERVER_INIT_LEGACY
327 // [2] u8 SER_FMT_VER_HIGHEST_READ
328 // [3] u8[20] player_name
329 // [23] u8[28] password (new in some version)
330 // [51] u16 minimum supported network protocol version (added sometime)
331 // [53] u16 maximum supported network protocol version (added later than the previous one)
333 char pName[PLAYERNAME_SIZE];
334 char pPassword[PASSWORD_SIZE];
335 memset(pName, 0, PLAYERNAME_SIZE * sizeof(char));
336 memset(pPassword, 0, PASSWORD_SIZE * sizeof(char));
338 std::string hashed_password = translate_password(myplayer->getName(), m_password);
339 snprintf(pName, PLAYERNAME_SIZE, "%s", myplayer->getName());
340 snprintf(pPassword, PASSWORD_SIZE, "%s", hashed_password.c_str());
342 sendLegacyInit(pName, pPassword);
344 if (CLIENT_PROTOCOL_VERSION_MAX >= 25)
345 sendInit(myplayer->getName());
348 // Not connected, return
353 Do stuff if connected
357 Run Map's timers and unload unused data
359 const float map_timer_and_unload_dtime = 5.25;
360 if(m_map_timer_and_unload_interval.step(dtime, map_timer_and_unload_dtime)) {
361 ScopeProfiler sp(g_profiler, "Client: map timer and unload");
362 std::vector<v3s16> deleted_blocks;
363 m_env.getMap().timerUpdate(map_timer_and_unload_dtime,
364 g_settings->getFloat("client_unload_unused_data_timeout"),
365 g_settings->getS32("client_mapblock_limit"),
370 NOTE: This loop is intentionally iterated the way it is.
373 std::vector<v3s16>::iterator i = deleted_blocks.begin();
374 std::vector<v3s16> sendlist;
376 if(sendlist.size() == 255 || i == deleted_blocks.end()) {
387 sendDeletedBlocks(sendlist);
389 if(i == deleted_blocks.end())
395 sendlist.push_back(*i);
403 // Control local player (0ms)
404 LocalPlayer *player = m_env.getLocalPlayer();
405 assert(player != NULL);
406 player->applyControl(dtime);
410 m_sound->step(dtime);
415 while (m_env.hasClientEnvEvents()) {
416 ClientEnvEvent envEvent = m_env.getClientEnvEvent();
418 if (envEvent.type == CEE_PLAYER_DAMAGE) {
419 if (m_ignore_damage_timer <= 0) {
420 u8 damage = envEvent.player_damage.amount;
422 if (envEvent.player_damage.send_to_server)
425 // Add to ClientEvent queue
427 event.type = CE_PLAYER_DAMAGE;
428 event.player_damage.amount = damage;
429 m_client_event_queue.push(event);
432 // Protocol v29 or greater obsoleted this event
433 else if (envEvent.type == CEE_PLAYER_BREATH && m_proto_ver < 29) {
434 u16 breath = envEvent.player_breath.amount;
442 float &counter = m_avg_rtt_timer;
446 // connectedAndInitialized() is true, peer exists.
447 float avg_rtt = getRTT();
448 infostream << "Client: avg_rtt=" << avg_rtt << std::endl;
452 Send player position to server
455 float &counter = m_playerpos_send_timer;
457 if((m_state == LC_Ready) && (counter >= m_recommended_send_interval))
465 Replace updated meshes
468 int num_processed_meshes = 0;
469 while (!m_mesh_update_thread.m_queue_out.empty())
471 num_processed_meshes++;
473 MinimapMapblock *minimap_mapblock = NULL;
474 bool do_mapper_update = true;
476 MeshUpdateResult r = m_mesh_update_thread.m_queue_out.pop_frontNoEx();
477 MapBlock *block = m_env.getMap().getBlockNoCreateNoEx(r.p);
479 // Delete the old mesh
480 if (block->mesh != NULL) {
486 minimap_mapblock = r.mesh->moveMinimapMapblock();
487 if (minimap_mapblock == NULL)
488 do_mapper_update = false;
490 bool is_empty = true;
491 for (int l = 0; l < MAX_TILE_LAYERS; l++)
492 if (r.mesh->getMesh(l)->getMeshBufferCount() != 0)
498 // Replace with the new mesh
499 block->mesh = r.mesh;
505 if (do_mapper_update)
506 m_minimap->addBlock(r.p, minimap_mapblock);
508 if (r.ack_block_to_server) {
518 if (num_processed_meshes > 0)
519 g_profiler->graphAdd("num_processed_meshes", num_processed_meshes);
525 if (m_media_downloader && m_media_downloader->isStarted()) {
526 m_media_downloader->step(this);
527 if (m_media_downloader->isDone()) {
528 delete m_media_downloader;
529 m_media_downloader = NULL;
534 If the server didn't update the inventory in a while, revert
535 the local inventory (so the player notices the lag problem
536 and knows something is wrong).
538 if(m_inventory_from_server)
540 float interval = 10.0;
541 float count_before = floor(m_inventory_from_server_age / interval);
543 m_inventory_from_server_age += dtime;
545 float count_after = floor(m_inventory_from_server_age / interval);
547 if(count_after != count_before)
549 // Do this every <interval> seconds after TOCLIENT_INVENTORY
550 // Reset the locally changed inventory to the authoritative inventory
551 LocalPlayer *player = m_env.getLocalPlayer();
552 player->inventory = *m_inventory_from_server;
553 m_inventory_updated = true;
558 Update positions of sounds attached to objects
561 for(UNORDERED_MAP<int, u16>::iterator i = m_sounds_to_objects.begin();
562 i != m_sounds_to_objects.end(); ++i) {
563 int client_id = i->first;
564 u16 object_id = i->second;
565 ClientActiveObject *cao = m_env.getActiveObject(object_id);
568 v3f pos = cao->getPosition();
569 m_sound->updateSoundPosition(client_id, pos);
574 Handle removed remotely initiated sounds
576 m_removed_sounds_check_timer += dtime;
577 if(m_removed_sounds_check_timer >= 2.32) {
578 m_removed_sounds_check_timer = 0;
579 // Find removed sounds and clear references to them
580 std::vector<s32> removed_server_ids;
581 for(UNORDERED_MAP<s32, int>::iterator i = m_sounds_server_to_client.begin();
582 i != m_sounds_server_to_client.end();) {
583 s32 server_id = i->first;
584 int client_id = i->second;
586 if(!m_sound->soundExists(client_id)) {
587 m_sounds_server_to_client.erase(server_id);
588 m_sounds_client_to_server.erase(client_id);
589 m_sounds_to_objects.erase(client_id);
590 removed_server_ids.push_back(server_id);
595 if(!removed_server_ids.empty()) {
596 sendRemovedSounds(removed_server_ids);
600 m_mod_storage_save_timer -= dtime;
601 if (m_mod_storage_save_timer <= 0.0f) {
602 verbosestream << "Saving registered mod storages." << std::endl;
603 m_mod_storage_save_timer = g_settings->getFloat("server_map_save_interval");
604 for (UNORDERED_MAP<std::string, ModMetadata *>::const_iterator
605 it = m_mod_storages.begin(); it != m_mod_storages.end(); ++it) {
606 if (it->second->isModified()) {
607 it->second->save(getModStoragePath());
613 if (m_localdb && m_localdb_save_interval.step(dtime,
614 m_cache_save_interval)) {
615 m_localdb->endSave();
616 m_localdb->beginSave();
620 bool Client::loadMedia(const std::string &data, const std::string &filename)
622 // Silly irrlicht's const-incorrectness
623 Buffer<char> data_rw(data.c_str(), data.size());
627 const char *image_ext[] = {
628 ".png", ".jpg", ".bmp", ".tga",
629 ".pcx", ".ppm", ".psd", ".wal", ".rgb",
632 name = removeStringEnd(filename, image_ext);
635 verbosestream<<"Client: Attempting to load image "
636 <<"file \""<<filename<<"\""<<std::endl;
638 io::IFileSystem *irrfs = m_device->getFileSystem();
639 video::IVideoDriver *vdrv = m_device->getVideoDriver();
641 // Create an irrlicht memory file
642 io::IReadFile *rfile = irrfs->createMemoryReadFile(
643 *data_rw, data_rw.getSize(), "_tempreadfile");
645 FATAL_ERROR_IF(!rfile, "Could not create irrlicht memory file.");
648 video::IImage *img = vdrv->createImageFromFile(rfile);
650 errorstream<<"Client: Cannot create image from data of "
651 <<"file \""<<filename<<"\""<<std::endl;
656 m_tsrc->insertSourceImage(filename, img);
663 const char *sound_ext[] = {
664 ".0.ogg", ".1.ogg", ".2.ogg", ".3.ogg", ".4.ogg",
665 ".5.ogg", ".6.ogg", ".7.ogg", ".8.ogg", ".9.ogg",
668 name = removeStringEnd(filename, sound_ext);
671 verbosestream<<"Client: Attempting to load sound "
672 <<"file \""<<filename<<"\""<<std::endl;
673 m_sound->loadSoundData(name, data);
677 const char *model_ext[] = {
678 ".x", ".b3d", ".md2", ".obj",
681 name = removeStringEnd(filename, model_ext);
684 verbosestream<<"Client: Storing model into memory: "
685 <<"\""<<filename<<"\""<<std::endl;
686 if(m_mesh_data.count(filename))
687 errorstream<<"Multiple models with name \""<<filename.c_str()
688 <<"\" found; replacing previous model"<<std::endl;
689 m_mesh_data[filename] = data;
693 errorstream<<"Client: Don't know how to load file \""
694 <<filename<<"\""<<std::endl;
698 // Virtual methods from con::PeerHandler
699 void Client::peerAdded(con::Peer *peer)
701 infostream << "Client::peerAdded(): peer->id="
702 << peer->id << std::endl;
704 void Client::deletingPeer(con::Peer *peer, bool timeout)
706 infostream << "Client::deletingPeer(): "
707 "Server Peer is getting deleted "
708 << "(timeout=" << timeout << ")" << std::endl;
711 m_access_denied = true;
712 m_access_denied_reason = gettext("Connection timed out.");
718 u16 number of files requested
724 void Client::request_media(const std::vector<std::string> &file_requests)
726 std::ostringstream os(std::ios_base::binary);
727 writeU16(os, TOSERVER_REQUEST_MEDIA);
728 size_t file_requests_size = file_requests.size();
730 FATAL_ERROR_IF(file_requests_size > 0xFFFF, "Unsupported number of file requests");
732 // Packet dynamicly resized
733 NetworkPacket pkt(TOSERVER_REQUEST_MEDIA, 2 + 0);
735 pkt << (u16) (file_requests_size & 0xFFFF);
737 for(std::vector<std::string>::const_iterator i = file_requests.begin();
738 i != file_requests.end(); ++i) {
744 infostream << "Client: Sending media request list to server ("
745 << file_requests.size() << " files. packet size)" << std::endl;
748 void Client::initLocalMapSaving(const Address &address,
749 const std::string &hostname,
750 bool is_local_server)
752 if (!g_settings->getBool("enable_local_map_saving") || is_local_server) {
756 const std::string world_path = porting::path_user
757 + DIR_DELIM + "worlds"
758 + DIR_DELIM + "server_"
759 + hostname + "_" + std::to_string(address.getPort());
761 fs::CreateAllDirs(world_path);
763 m_localdb = new MapDatabaseSQLite3(world_path);
764 m_localdb->beginSave();
765 actionstream << "Local map saving started, map will be saved at '" << world_path << "'" << std::endl;
768 void Client::ReceiveAll()
770 DSTACK(FUNCTION_NAME);
771 u64 start_ms = porting::getTimeMs();
774 // Limit time even if there would be huge amounts of data to
776 if(porting::getTimeMs() > start_ms + 100)
781 g_profiler->graphAdd("client_received_packets", 1);
783 catch(con::NoIncomingDataException &e) {
786 catch(con::InvalidIncomingDataException &e) {
787 infostream<<"Client::ReceiveAll(): "
788 "InvalidIncomingDataException: what()="
789 <<e.what()<<std::endl;
794 void Client::Receive()
796 DSTACK(FUNCTION_NAME);
802 inline void Client::handleCommand(NetworkPacket* pkt)
804 const ToClientCommandHandler& opHandle = toClientCommandTable[pkt->getCommand()];
805 (this->*opHandle.handler)(pkt);
809 sender_peer_id given to this shall be quaranteed to be a valid peer
811 void Client::ProcessData(NetworkPacket *pkt)
813 DSTACK(FUNCTION_NAME);
815 ToClientCommand command = (ToClientCommand) pkt->getCommand();
816 u32 sender_peer_id = pkt->getPeerId();
818 //infostream<<"Client: received command="<<command<<std::endl;
819 m_packetcounter.add((u16)command);
822 If this check is removed, be sure to change the queue
823 system to know the ids
825 if(sender_peer_id != PEER_ID_SERVER) {
826 infostream << "Client::ProcessData(): Discarding data not "
827 "coming from server: peer_id=" << sender_peer_id
832 // Command must be handled into ToClientCommandHandler
833 if (command >= TOCLIENT_NUM_MSG_TYPES) {
834 infostream << "Client: Ignoring unknown command "
835 << command << std::endl;
840 * Those packets are handled before m_server_ser_ver is set, it's normal
841 * But we must use the new ToClientConnectionState in the future,
844 if(toClientCommandTable[command].state == TOCLIENT_STATE_NOT_CONNECTED) {
849 if(m_server_ser_ver == SER_FMT_VER_INVALID) {
850 infostream << "Client: Server serialization"
851 " format invalid or not initialized."
852 " Skipping incoming command=" << command << std::endl;
857 Handle runtime commands
863 void Client::Send(NetworkPacket* pkt)
865 m_con.Send(PEER_ID_SERVER,
866 serverCommandFactoryTable[pkt->getCommand()].channel,
868 serverCommandFactoryTable[pkt->getCommand()].reliable);
871 // Will fill up 12 + 12 + 4 + 4 + 4 bytes
872 void writePlayerPos(LocalPlayer *myplayer, ClientMap *clientMap, NetworkPacket *pkt)
874 v3f pf = myplayer->getPosition() * 100;
875 v3f sf = myplayer->getSpeed() * 100;
876 s32 pitch = myplayer->getPitch() * 100;
877 s32 yaw = myplayer->getYaw() * 100;
878 u32 keyPressed = myplayer->keyPressed;
879 // scaled by 80, so that pi can fit into a u8
880 u8 fov = clientMap->getCameraFov() * 80;
881 u8 wanted_range = MYMIN(255,
882 std::ceil(clientMap->getControl().wanted_range / MAP_BLOCKSIZE));
884 v3s32 position(pf.X, pf.Y, pf.Z);
885 v3s32 speed(sf.X, sf.Y, sf.Z);
889 [0] v3s32 position*100
891 [12+12] s32 pitch*100
892 [12+12+4] s32 yaw*100
893 [12+12+4+4] u32 keyPressed
894 [12+12+4+4+4] u8 fov*80
895 [12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
897 *pkt << position << speed << pitch << yaw << keyPressed;
898 *pkt << fov << wanted_range;
901 void Client::interact(u8 action, const PointedThing& pointed)
903 if(m_state != LC_Ready) {
904 errorstream << "Client::interact() "
905 "Canceled (not connected)"
910 LocalPlayer *myplayer = m_env.getLocalPlayer();
911 if (myplayer == NULL)
918 [5] u32 length of the next item (plen)
919 [9] serialized PointedThing
920 [9 + plen] player position information
922 0: start digging (from undersurface) or use
923 1: stop digging (all parameters ignored)
925 3: place block or item (to abovesurface)
927 5: perform secondary action of item
930 NetworkPacket pkt(TOSERVER_INTERACT, 1 + 2 + 0);
933 pkt << (u16)getPlayerItem();
935 std::ostringstream tmp_os(std::ios::binary);
936 pointed.serialize(tmp_os);
938 pkt.putLongString(tmp_os.str());
940 writePlayerPos(myplayer, &m_env.getClientMap(), &pkt);
945 void Client::deleteAuthData()
950 switch (m_chosen_auth_mech) {
951 case AUTH_MECHANISM_FIRST_SRP:
953 case AUTH_MECHANISM_SRP:
954 case AUTH_MECHANISM_LEGACY_PASSWORD:
955 srp_user_delete((SRPUser *) m_auth_data);
958 case AUTH_MECHANISM_NONE:
961 m_chosen_auth_mech = AUTH_MECHANISM_NONE;
965 AuthMechanism Client::choseAuthMech(const u32 mechs)
967 if (mechs & AUTH_MECHANISM_SRP)
968 return AUTH_MECHANISM_SRP;
970 if (mechs & AUTH_MECHANISM_FIRST_SRP)
971 return AUTH_MECHANISM_FIRST_SRP;
973 if (mechs & AUTH_MECHANISM_LEGACY_PASSWORD)
974 return AUTH_MECHANISM_LEGACY_PASSWORD;
976 return AUTH_MECHANISM_NONE;
979 void Client::sendLegacyInit(const char* playerName, const char* playerPassword)
981 NetworkPacket pkt(TOSERVER_INIT_LEGACY,
982 1 + PLAYERNAME_SIZE + PASSWORD_SIZE + 2 + 2);
984 u16 proto_version_min = g_settings->getFlag("send_pre_v25_init") ?
985 CLIENT_PROTOCOL_VERSION_MIN_LEGACY : CLIENT_PROTOCOL_VERSION_MIN;
987 pkt << (u8) SER_FMT_VER_HIGHEST_READ;
988 pkt.putRawString(playerName,PLAYERNAME_SIZE);
989 pkt.putRawString(playerPassword, PASSWORD_SIZE);
990 pkt << (u16) proto_version_min << (u16) CLIENT_PROTOCOL_VERSION_MAX;
995 void Client::sendInit(const std::string &playerName)
997 NetworkPacket pkt(TOSERVER_INIT, 1 + 2 + 2 + (1 + playerName.size()));
999 // we don't support network compression yet
1000 u16 supp_comp_modes = NETPROTO_COMPRESSION_NONE;
1002 u16 proto_version_min = g_settings->getFlag("send_pre_v25_init") ?
1003 CLIENT_PROTOCOL_VERSION_MIN_LEGACY : CLIENT_PROTOCOL_VERSION_MIN;
1005 pkt << (u8) SER_FMT_VER_HIGHEST_READ << (u16) supp_comp_modes;
1006 pkt << (u16) proto_version_min << (u16) CLIENT_PROTOCOL_VERSION_MAX;
1012 void Client::startAuth(AuthMechanism chosen_auth_mechanism)
1014 m_chosen_auth_mech = chosen_auth_mechanism;
1016 switch (chosen_auth_mechanism) {
1017 case AUTH_MECHANISM_FIRST_SRP: {
1018 // send srp verifier to server
1019 std::string verifier;
1021 generate_srp_verifier_and_salt(getPlayerName(), m_password,
1024 NetworkPacket resp_pkt(TOSERVER_FIRST_SRP, 0);
1025 resp_pkt << salt << verifier << (u8)((m_password == "") ? 1 : 0);
1030 case AUTH_MECHANISM_SRP:
1031 case AUTH_MECHANISM_LEGACY_PASSWORD: {
1034 if (chosen_auth_mechanism == AUTH_MECHANISM_LEGACY_PASSWORD) {
1035 m_password = translate_password(getPlayerName(), m_password);
1039 std::string playername_u = lowercase(getPlayerName());
1040 m_auth_data = srp_user_new(SRP_SHA256, SRP_NG_2048,
1041 getPlayerName().c_str(), playername_u.c_str(),
1042 (const unsigned char *) m_password.c_str(),
1043 m_password.length(), NULL, NULL);
1046 SRP_Result res = srp_user_start_authentication(
1047 (struct SRPUser *) m_auth_data, NULL, NULL, 0,
1048 (unsigned char **) &bytes_A, &len_A);
1049 FATAL_ERROR_IF(res != SRP_OK, "Creating local SRP user failed.");
1051 NetworkPacket resp_pkt(TOSERVER_SRP_BYTES_A, 0);
1052 resp_pkt << std::string(bytes_A, len_A) << based_on;
1056 case AUTH_MECHANISM_NONE:
1057 break; // not handled in this method
1061 void Client::sendDeletedBlocks(std::vector<v3s16> &blocks)
1063 NetworkPacket pkt(TOSERVER_DELETEDBLOCKS, 1 + sizeof(v3s16) * blocks.size());
1065 pkt << (u8) blocks.size();
1068 for(std::vector<v3s16>::iterator
1070 j != blocks.end(); ++j) {
1078 void Client::sendGotBlocks(v3s16 block)
1080 NetworkPacket pkt(TOSERVER_GOTBLOCKS, 1 + 6);
1081 pkt << (u8) 1 << block;
1085 void Client::sendRemovedSounds(std::vector<s32> &soundList)
1087 size_t server_ids = soundList.size();
1088 assert(server_ids <= 0xFFFF);
1090 NetworkPacket pkt(TOSERVER_REMOVED_SOUNDS, 2 + server_ids * 4);
1092 pkt << (u16) (server_ids & 0xFFFF);
1094 for(std::vector<s32>::iterator i = soundList.begin();
1095 i != soundList.end(); ++i)
1101 void Client::sendNodemetaFields(v3s16 p, const std::string &formname,
1102 const StringMap &fields)
1104 size_t fields_size = fields.size();
1106 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of nodemeta fields");
1108 NetworkPacket pkt(TOSERVER_NODEMETA_FIELDS, 0);
1110 pkt << p << formname << (u16) (fields_size & 0xFFFF);
1112 StringMap::const_iterator it;
1113 for (it = fields.begin(); it != fields.end(); ++it) {
1114 const std::string &name = it->first;
1115 const std::string &value = it->second;
1117 pkt.putLongString(value);
1123 void Client::sendInventoryFields(const std::string &formname,
1124 const StringMap &fields)
1126 size_t fields_size = fields.size();
1127 FATAL_ERROR_IF(fields_size > 0xFFFF, "Unsupported number of inventory fields");
1129 NetworkPacket pkt(TOSERVER_INVENTORY_FIELDS, 0);
1130 pkt << formname << (u16) (fields_size & 0xFFFF);
1132 StringMap::const_iterator it;
1133 for (it = fields.begin(); it != fields.end(); ++it) {
1134 const std::string &name = it->first;
1135 const std::string &value = it->second;
1137 pkt.putLongString(value);
1143 void Client::sendInventoryAction(InventoryAction *a)
1145 std::ostringstream os(std::ios_base::binary);
1150 std::string s = os.str();
1152 NetworkPacket pkt(TOSERVER_INVENTORY_ACTION, s.size());
1153 pkt.putRawString(s.c_str(),s.size());
1158 void Client::sendChatMessage(const std::wstring &message)
1160 NetworkPacket pkt(TOSERVER_CHAT_MESSAGE, 2 + message.size() * sizeof(u16));
1167 void Client::sendChangePassword(const std::string &oldpassword,
1168 const std::string &newpassword)
1170 LocalPlayer *player = m_env.getLocalPlayer();
1174 std::string playername = player->getName();
1175 if (m_proto_ver >= 25) {
1176 // get into sudo mode and then send new password to server
1177 m_password = oldpassword;
1178 m_new_password = newpassword;
1179 startAuth(choseAuthMech(m_sudo_auth_methods));
1181 std::string oldpwd = translate_password(playername, oldpassword);
1182 std::string newpwd = translate_password(playername, newpassword);
1184 NetworkPacket pkt(TOSERVER_PASSWORD_LEGACY, 2 * PASSWORD_SIZE);
1186 for (u8 i = 0; i < PASSWORD_SIZE; i++) {
1187 pkt << (u8) (i < oldpwd.length() ? oldpwd[i] : 0);
1190 for (u8 i = 0; i < PASSWORD_SIZE; i++) {
1191 pkt << (u8) (i < newpwd.length() ? newpwd[i] : 0);
1198 void Client::sendDamage(u8 damage)
1200 DSTACK(FUNCTION_NAME);
1202 NetworkPacket pkt(TOSERVER_DAMAGE, sizeof(u8));
1207 void Client::sendBreath(u16 breath)
1209 DSTACK(FUNCTION_NAME);
1211 // Protocol v29 make this obsolete
1212 if (m_proto_ver >= 29)
1215 NetworkPacket pkt(TOSERVER_BREATH, sizeof(u16));
1220 void Client::sendRespawn()
1222 DSTACK(FUNCTION_NAME);
1224 NetworkPacket pkt(TOSERVER_RESPAWN, 0);
1228 void Client::sendReady()
1230 DSTACK(FUNCTION_NAME);
1232 NetworkPacket pkt(TOSERVER_CLIENT_READY,
1233 1 + 1 + 1 + 1 + 2 + sizeof(char) * strlen(g_version_hash));
1235 pkt << (u8) VERSION_MAJOR << (u8) VERSION_MINOR << (u8) VERSION_PATCH
1236 << (u8) 0 << (u16) strlen(g_version_hash);
1238 pkt.putRawString(g_version_hash, (u16) strlen(g_version_hash));
1242 void Client::sendPlayerPos()
1244 LocalPlayer *myplayer = m_env.getLocalPlayer();
1245 if(myplayer == NULL)
1248 ClientMap &map = m_env.getClientMap();
1250 u8 camera_fov = map.getCameraFov();
1251 u8 wanted_range = map.getControl().wanted_range;
1253 // Save bandwidth by only updating position when something changed
1254 if(myplayer->last_position == myplayer->getPosition() &&
1255 myplayer->last_speed == myplayer->getSpeed() &&
1256 myplayer->last_pitch == myplayer->getPitch() &&
1257 myplayer->last_yaw == myplayer->getYaw() &&
1258 myplayer->last_keyPressed == myplayer->keyPressed &&
1259 myplayer->last_camera_fov == camera_fov &&
1260 myplayer->last_wanted_range == wanted_range)
1263 myplayer->last_position = myplayer->getPosition();
1264 myplayer->last_speed = myplayer->getSpeed();
1265 myplayer->last_pitch = myplayer->getPitch();
1266 myplayer->last_yaw = myplayer->getYaw();
1267 myplayer->last_keyPressed = myplayer->keyPressed;
1268 myplayer->last_camera_fov = camera_fov;
1269 myplayer->last_wanted_range = wanted_range;
1271 //infostream << "Sending Player Position information" << std::endl;
1275 //MutexAutoLock lock(m_con_mutex); //bulk comment-out
1276 our_peer_id = m_con.GetPeerID();
1279 // Set peer id if not set already
1280 if(myplayer->peer_id == PEER_ID_INEXISTENT)
1281 myplayer->peer_id = our_peer_id;
1283 assert(myplayer->peer_id == our_peer_id);
1285 NetworkPacket pkt(TOSERVER_PLAYERPOS, 12 + 12 + 4 + 4 + 4 + 1 + 1);
1287 writePlayerPos(myplayer, &map, &pkt);
1292 void Client::sendPlayerItem(u16 item)
1294 LocalPlayer *myplayer = m_env.getLocalPlayer();
1295 if(myplayer == NULL)
1298 u16 our_peer_id = m_con.GetPeerID();
1300 // Set peer id if not set already
1301 if(myplayer->peer_id == PEER_ID_INEXISTENT)
1302 myplayer->peer_id = our_peer_id;
1303 assert(myplayer->peer_id == our_peer_id);
1305 NetworkPacket pkt(TOSERVER_PLAYERITEM, 2);
1312 void Client::removeNode(v3s16 p)
1314 std::map<v3s16, MapBlock*> modified_blocks;
1317 m_env.getMap().removeNodeAndUpdate(p, modified_blocks);
1319 catch(InvalidPositionException &e) {
1322 for(std::map<v3s16, MapBlock *>::iterator
1323 i = modified_blocks.begin();
1324 i != modified_blocks.end(); ++i) {
1325 addUpdateMeshTaskWithEdge(i->first, false, true);
1329 MapNode Client::getNode(v3s16 p, bool *is_valid_position)
1331 return m_env.getMap().getNodeNoEx(p, is_valid_position);
1334 void Client::addNode(v3s16 p, MapNode n, bool remove_metadata)
1336 //TimeTaker timer1("Client::addNode()");
1338 std::map<v3s16, MapBlock*> modified_blocks;
1341 //TimeTaker timer3("Client::addNode(): addNodeAndUpdate");
1342 m_env.getMap().addNodeAndUpdate(p, n, modified_blocks, remove_metadata);
1344 catch(InvalidPositionException &e) {
1347 for(std::map<v3s16, MapBlock *>::iterator
1348 i = modified_blocks.begin();
1349 i != modified_blocks.end(); ++i) {
1350 addUpdateMeshTaskWithEdge(i->first, false, true);
1354 void Client::setPlayerControl(PlayerControl &control)
1356 LocalPlayer *player = m_env.getLocalPlayer();
1357 assert(player != NULL);
1358 player->control = control;
1361 void Client::selectPlayerItem(u16 item)
1363 m_playeritem = item;
1364 m_inventory_updated = true;
1365 sendPlayerItem(item);
1368 // Returns true if the inventory of the local player has been
1369 // updated from the server. If it is true, it is set to false.
1370 bool Client::getLocalInventoryUpdated()
1372 bool updated = m_inventory_updated;
1373 m_inventory_updated = false;
1377 // Copies the inventory of the local player to parameter
1378 void Client::getLocalInventory(Inventory &dst)
1380 LocalPlayer *player = m_env.getLocalPlayer();
1381 assert(player != NULL);
1382 dst = player->inventory;
1385 Inventory* Client::getInventory(const InventoryLocation &loc)
1388 case InventoryLocation::UNDEFINED:
1391 case InventoryLocation::CURRENT_PLAYER:
1393 LocalPlayer *player = m_env.getLocalPlayer();
1394 assert(player != NULL);
1395 return &player->inventory;
1398 case InventoryLocation::PLAYER:
1400 // Check if we are working with local player inventory
1401 LocalPlayer *player = m_env.getLocalPlayer();
1402 if (!player || strcmp(player->getName(), loc.name.c_str()) != 0)
1404 return &player->inventory;
1407 case InventoryLocation::NODEMETA:
1409 NodeMetadata *meta = m_env.getMap().getNodeMetadata(loc.p);
1412 return meta->getInventory();
1415 case InventoryLocation::DETACHED:
1417 if (m_detached_inventories.count(loc.name) == 0)
1419 return m_detached_inventories[loc.name];
1423 FATAL_ERROR("Invalid inventory location type.");
1429 void Client::inventoryAction(InventoryAction *a)
1432 Send it to the server
1434 sendInventoryAction(a);
1437 Predict some local inventory changes
1439 a->clientApply(this, this);
1445 float Client::getAnimationTime()
1447 return m_animation_time;
1450 int Client::getCrackLevel()
1452 return m_crack_level;
1455 v3s16 Client::getCrackPos()
1460 void Client::setCrack(int level, v3s16 pos)
1462 int old_crack_level = m_crack_level;
1463 v3s16 old_crack_pos = m_crack_pos;
1465 m_crack_level = level;
1468 if(old_crack_level >= 0 && (level < 0 || pos != old_crack_pos))
1471 addUpdateMeshTaskForNode(old_crack_pos, false, true);
1473 if(level >= 0 && (old_crack_level < 0 || pos != old_crack_pos))
1476 addUpdateMeshTaskForNode(pos, false, true);
1482 LocalPlayer *player = m_env.getLocalPlayer();
1483 assert(player != NULL);
1487 bool Client::getChatMessage(std::wstring &message)
1489 if(m_chat_queue.size() == 0)
1491 message = m_chat_queue.front();
1496 void Client::typeChatMessage(const std::wstring &message)
1498 // Discard empty line
1502 // If message was ate by script API, don't send it to server
1503 if (m_script->on_sending_message(wide_to_utf8(message))) {
1508 sendChatMessage(message);
1511 if (message[0] != L'/')
1513 // compatibility code
1514 if (m_proto_ver < 29) {
1515 LocalPlayer *player = m_env.getLocalPlayer();
1516 assert(player != NULL);
1517 std::wstring name = narrow_to_wide(player->getName());
1518 pushToChatQueue((std::wstring)L"<" + name + L"> " + message);
1523 void Client::addUpdateMeshTask(v3s16 p, bool ack_to_server, bool urgent)
1525 // Check if the block exists to begin with. In the case when a non-existing
1526 // neighbor is automatically added, it may not. In that case we don't want
1527 // to tell the mesh update thread about it.
1528 MapBlock *b = m_env.getMap().getBlockNoCreateNoEx(p);
1532 m_mesh_update_thread.updateBlock(&m_env.getMap(), p, ack_to_server, urgent);
1535 void Client::addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server, bool urgent)
1538 addUpdateMeshTask(blockpos, ack_to_server, urgent);
1540 catch(InvalidPositionException &e){}
1543 for (int i=0;i<6;i++)
1546 v3s16 p = blockpos + g_6dirs[i];
1547 addUpdateMeshTask(p, false, urgent);
1549 catch(InvalidPositionException &e){}
1553 void Client::addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server, bool urgent)
1557 infostream<<"Client::addUpdateMeshTaskForNode(): "
1558 <<"("<<p.X<<","<<p.Y<<","<<p.Z<<")"
1562 v3s16 blockpos = getNodeBlockPos(nodepos);
1563 v3s16 blockpos_relative = blockpos * MAP_BLOCKSIZE;
1566 addUpdateMeshTask(blockpos, ack_to_server, urgent);
1568 catch(InvalidPositionException &e) {}
1571 if(nodepos.X == blockpos_relative.X){
1573 v3s16 p = blockpos + v3s16(-1,0,0);
1574 addUpdateMeshTask(p, false, urgent);
1576 catch(InvalidPositionException &e){}
1579 if(nodepos.Y == blockpos_relative.Y){
1581 v3s16 p = blockpos + v3s16(0,-1,0);
1582 addUpdateMeshTask(p, false, urgent);
1584 catch(InvalidPositionException &e){}
1587 if(nodepos.Z == blockpos_relative.Z){
1589 v3s16 p = blockpos + v3s16(0,0,-1);
1590 addUpdateMeshTask(p, false, urgent);
1592 catch(InvalidPositionException &e){}
1596 ClientEvent Client::getClientEvent()
1598 FATAL_ERROR_IF(m_client_event_queue.empty(),
1599 "Cannot getClientEvent, queue is empty.");
1601 ClientEvent event = m_client_event_queue.front();
1602 m_client_event_queue.pop();
1606 float Client::mediaReceiveProgress()
1608 if (m_media_downloader)
1609 return m_media_downloader->getProgress();
1611 return 1.0; // downloader only exists when not yet done
1614 typedef struct TextureUpdateArgs {
1615 IrrlichtDevice *device;
1616 gui::IGUIEnvironment *guienv;
1619 const wchar_t* text_base;
1620 ITextureSource *tsrc;
1621 } TextureUpdateArgs;
1623 void texture_update_progress(void *args, u32 progress, u32 max_progress)
1625 TextureUpdateArgs* targs = (TextureUpdateArgs*) args;
1626 u16 cur_percent = ceil(progress / (double) max_progress * 100.);
1628 // update the loading menu -- if neccessary
1629 bool do_draw = false;
1630 u64 time_ms = targs->last_time_ms;
1631 if (cur_percent != targs->last_percent) {
1632 targs->last_percent = cur_percent;
1633 time_ms = porting::getTimeMs();
1634 // only draw when the user will notice something:
1635 do_draw = (time_ms - targs->last_time_ms > 100);
1639 targs->last_time_ms = time_ms;
1640 std::basic_stringstream<wchar_t> strm;
1641 strm << targs->text_base << " " << targs->last_percent << "%...";
1642 draw_load_screen(strm.str(), targs->device, targs->guienv, targs->tsrc, 0,
1643 72 + (u16) ((18. / 100.) * (double) targs->last_percent), true);
1647 void Client::afterContentReceived(IrrlichtDevice *device)
1649 infostream<<"Client::afterContentReceived() started"<<std::endl;
1650 assert(m_itemdef_received); // pre-condition
1651 assert(m_nodedef_received); // pre-condition
1652 assert(mediaReceived()); // pre-condition
1654 const wchar_t* text = wgettext("Loading textures...");
1656 // Clear cached pre-scaled 2D GUI images, as this cache
1657 // might have images with the same name but different
1658 // content from previous sessions.
1659 guiScalingCacheClear(device->getVideoDriver());
1661 // Rebuild inherited images and recreate textures
1662 infostream<<"- Rebuilding images and textures"<<std::endl;
1663 draw_load_screen(text,device, guienv, m_tsrc, 0, 70);
1664 m_tsrc->rebuildImagesAndTextures();
1668 infostream<<"- Rebuilding shaders"<<std::endl;
1669 text = wgettext("Rebuilding shaders...");
1670 draw_load_screen(text, device, guienv, m_tsrc, 0, 71);
1671 m_shsrc->rebuildShaders();
1674 // Update node aliases
1675 infostream<<"- Updating node aliases"<<std::endl;
1676 text = wgettext("Initializing nodes...");
1677 draw_load_screen(text, device, guienv, m_tsrc, 0, 72);
1678 m_nodedef->updateAliases(m_itemdef);
1679 std::string texture_path = g_settings->get("texture_path");
1680 if (texture_path != "" && fs::IsDir(texture_path))
1681 m_nodedef->applyTextureOverrides(texture_path + DIR_DELIM + "override.txt");
1682 m_nodedef->setNodeRegistrationStatus(true);
1683 m_nodedef->runNodeResolveCallbacks();
1686 // Update node textures and assign shaders to each tile
1687 infostream<<"- Updating node textures"<<std::endl;
1688 TextureUpdateArgs tu_args;
1689 tu_args.device = device;
1690 tu_args.guienv = guienv;
1691 tu_args.last_time_ms = porting::getTimeMs();
1692 tu_args.last_percent = 0;
1693 tu_args.text_base = wgettext("Initializing nodes");
1694 tu_args.tsrc = m_tsrc;
1695 m_nodedef->updateTextures(this, texture_update_progress, &tu_args);
1696 delete[] tu_args.text_base;
1698 // Start mesh update thread after setting up content definitions
1699 infostream<<"- Starting mesh update thread"<<std::endl;
1700 m_mesh_update_thread.start();
1705 if (g_settings->getBool("enable_client_modding")) {
1706 m_script->on_client_ready(m_env.getLocalPlayer());
1707 m_script->on_connect();
1710 text = wgettext("Done!");
1711 draw_load_screen(text, device, guienv, m_tsrc, 0, 100);
1712 infostream<<"Client::afterContentReceived() done"<<std::endl;
1716 float Client::getRTT()
1718 return m_con.getPeerStat(PEER_ID_SERVER,con::AVG_RTT);
1721 float Client::getCurRate()
1723 return ( m_con.getLocalStat(con::CUR_INC_RATE) +
1724 m_con.getLocalStat(con::CUR_DL_RATE));
1727 void Client::makeScreenshot(IrrlichtDevice *device)
1729 irr::video::IVideoDriver *driver = device->getVideoDriver();
1730 irr::video::IImage* const raw_image = driver->createScreenShot();
1735 time_t t = time(NULL);
1736 struct tm *tm = localtime(&t);
1738 char timetstamp_c[64];
1739 strftime(timetstamp_c, sizeof(timetstamp_c), "%Y%m%d_%H%M%S", tm);
1741 std::string filename_base = g_settings->get("screenshot_path")
1743 + std::string("screenshot_")
1744 + std::string(timetstamp_c);
1745 std::string filename_ext = "." + g_settings->get("screenshot_format");
1746 std::string filename;
1748 u32 quality = (u32)g_settings->getS32("screenshot_quality");
1749 quality = MYMIN(MYMAX(quality, 0), 100) / 100.0 * 255;
1751 // Try to find a unique filename
1752 unsigned serial = 0;
1754 while (serial < SCREENSHOT_MAX_SERIAL_TRIES) {
1755 filename = filename_base + (serial > 0 ? ("_" + itos(serial)) : "") + filename_ext;
1756 std::ifstream tmp(filename.c_str());
1758 break; // File did not apparently exist, we'll go with it
1762 if (serial == SCREENSHOT_MAX_SERIAL_TRIES) {
1763 infostream << "Could not find suitable filename for screenshot" << std::endl;
1765 irr::video::IImage* const image =
1766 driver->createImage(video::ECF_R8G8B8, raw_image->getDimension());
1769 raw_image->copyTo(image);
1771 std::ostringstream sstr;
1772 if (driver->writeImageToFile(image, filename.c_str(), quality)) {
1773 sstr << "Saved screenshot to '" << filename << "'";
1775 sstr << "Failed to save screenshot '" << filename << "'";
1777 pushToChatQueue(narrow_to_wide(sstr.str()));
1778 infostream << sstr.str() << std::endl;
1786 bool Client::shouldShowMinimap() const
1788 return !m_minimap_disabled_by_server;
1791 void Client::showGameChat(const bool show)
1793 m_game_ui_flags->show_chat = show;
1796 void Client::showGameHud(const bool show)
1798 m_game_ui_flags->show_hud = show;
1801 void Client::showMinimap(const bool show)
1803 m_game_ui_flags->show_minimap = show;
1806 void Client::showProfiler(const bool show)
1808 m_game_ui_flags->show_profiler_graph = show;
1811 void Client::showGameFog(const bool show)
1813 m_game_ui_flags->force_fog_off = !show;
1816 void Client::showGameDebug(const bool show)
1818 m_game_ui_flags->show_debug = show;
1821 // IGameDef interface
1823 IItemDefManager* Client::getItemDefManager()
1827 INodeDefManager* Client::getNodeDefManager()
1831 ICraftDefManager* Client::getCraftDefManager()
1834 //return m_craftdef;
1836 ITextureSource* Client::getTextureSource()
1840 IShaderSource* Client::getShaderSource()
1844 scene::ISceneManager* Client::getSceneManager()
1846 return m_device->getSceneManager();
1848 u16 Client::allocateUnknownNodeId(const std::string &name)
1850 errorstream << "Client::allocateUnknownNodeId(): "
1851 << "Client cannot allocate node IDs" << std::endl;
1852 FATAL_ERROR("Client allocated unknown node");
1854 return CONTENT_IGNORE;
1856 ISoundManager* Client::getSoundManager()
1860 MtEventManager* Client::getEventManager()
1865 ParticleManager* Client::getParticleManager()
1867 return &m_particle_manager;
1870 scene::IAnimatedMesh* Client::getMesh(const std::string &filename)
1872 StringMap::const_iterator it = m_mesh_data.find(filename);
1873 if (it == m_mesh_data.end()) {
1874 errorstream << "Client::getMesh(): Mesh not found: \"" << filename
1875 << "\"" << std::endl;
1878 const std::string &data = it->second;
1879 scene::ISceneManager *smgr = m_device->getSceneManager();
1881 // Create the mesh, remove it from cache and return it
1882 // This allows unique vertex colors and other properties for each instance
1883 Buffer<char> data_rw(data.c_str(), data.size()); // Const-incorrect Irrlicht
1884 io::IFileSystem *irrfs = m_device->getFileSystem();
1885 io::IReadFile *rfile = irrfs->createMemoryReadFile(
1886 *data_rw, data_rw.getSize(), filename.c_str());
1887 FATAL_ERROR_IF(!rfile, "Could not create/open RAM file");
1889 scene::IAnimatedMesh *mesh = smgr->getMesh(rfile);
1891 // NOTE: By playing with Irrlicht refcounts, maybe we could cache a bunch
1892 // of uniquely named instances and re-use them
1894 smgr->getMeshCache()->removeMesh(mesh);
1898 bool Client::registerModStorage(ModMetadata *storage)
1900 if (m_mod_storages.find(storage->getModName()) != m_mod_storages.end()) {
1901 errorstream << "Unable to register same mod storage twice. Storage name: "
1902 << storage->getModName() << std::endl;
1906 m_mod_storages[storage->getModName()] = storage;
1910 void Client::unregisterModStorage(const std::string &name)
1912 UNORDERED_MAP<std::string, ModMetadata *>::const_iterator it = m_mod_storages.find(name);
1913 if (it != m_mod_storages.end()) {
1914 // Save unconditionaly on unregistration
1915 it->second->save(getModStoragePath());
1916 m_mod_storages.erase(name);
1920 std::string Client::getModStoragePath() const
1922 return porting::path_user + DIR_DELIM + "client" + DIR_DELIM + "mod_storage";