src/player.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2010-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 #include "player.h"
  21
  22 #include <fstream>
  23 #include "jthread/jmutexautolock.h"
  24 #include "util/numeric.h"
  25 #include "hud.h"
  26 #include "constants.h"
  27 #include "gamedef.h"
  28 #include "settings.h"
  29 #include "content_sao.h"
  30 #include "filesys.h"
  31 #include "log.h"
  32 #include "porting.h"  // strlcpy
  33
  34
  35 Player::Player(IGameDef *gamedef, const char *name):
  36         touching_ground(false),
  37         in_liquid(false),
  38         in_liquid_stable(false),
  39         liquid_viscosity(0),
  40         is_climbing(false),
  41         swimming_vertical(false),
  42         camera_barely_in_ceiling(false),
  43         inventory(gamedef->idef()),
  44         hp(PLAYER_MAX_HP),
  45         hurt_tilt_timer(0),
  46         hurt_tilt_strength(0),
  47         peer_id(PEER_ID_INEXISTENT),
  48         keyPressed(0),
  49 // protected
  50         m_gamedef(gamedef),
  51         m_breath(PLAYER_MAX_BREATH),
  52         m_pitch(0),
  53         m_yaw(0),
  54         m_speed(0,0,0),
  55         m_position(0,0,0),
  56         m_collisionbox(-BS*0.30,0.0,-BS*0.30,BS*0.30,BS*1.75,BS*0.30),
  57         m_dirty(false)
  58 {
  59         strlcpy(m_name, name, PLAYERNAME_SIZE);
  60
  61         inventory.clear();
  62         inventory.addList("main", PLAYER_INVENTORY_SIZE);
  63         InventoryList *craft = inventory.addList("craft", 9);
  64         craft->setWidth(3);
  65         inventory.addList("craftpreview", 1);
  66         inventory.addList("craftresult", 1);
  67         inventory.setModified(false);
  68
  69         // Can be redefined via Lua
  70         inventory_formspec = "size[8,7.5]"
  71                 //"image[1,0.6;1,2;player.png]"
  72                 "list[current_player;main;0,3.5;8,4;]"
  73                 "list[current_player;craft;3,0;3,3;]"
  74                 "listring[]"
  75                 "list[current_player;craftpreview;7,1;1,1;]";
  76
  77         // Initialize movement settings at default values, so movement can work if the server fails to send them
  78         movement_acceleration_default   = 3    * BS;
  79         movement_acceleration_air       = 2    * BS;
  80         movement_acceleration_fast      = 10   * BS;
  81         movement_speed_walk             = 4    * BS;
  82         movement_speed_crouch           = 1.35 * BS;
  83         movement_speed_fast             = 20   * BS;
  84         movement_speed_climb            = 2    * BS;
  85         movement_speed_jump             = 6.5  * BS;
  86         movement_liquid_fluidity        = 1    * BS;
  87         movement_liquid_fluidity_smooth = 0.5  * BS;
  88         movement_liquid_sink            = 10   * BS;
  89         movement_gravity                = 9.81 * BS;
  90         local_animation_speed           = 0.0;
  91
  92         // Movement overrides are multipliers and must be 1 by default
  93         physics_override_speed        = 1;
  94         physics_override_jump         = 1;
  95         physics_override_gravity      = 1;
  96         physics_override_sneak        = true;
  97         physics_override_sneak_glitch = true;
  98
  99         hud_flags = HUD_FLAG_HOTBAR_VISIBLE | HUD_FLAG_HEALTHBAR_VISIBLE |
 100                          HUD_FLAG_CROSSHAIR_VISIBLE | HUD_FLAG_WIELDITEM_VISIBLE |
 101                          HUD_FLAG_BREATHBAR_VISIBLE;
 102
 103         hud_hotbar_itemcount = HUD_HOTBAR_ITEMCOUNT_DEFAULT;
 104 }
 105
 106 Player::~Player()
 107 {
 108         clearHud();
 109 }
 110
 111 // Horizontal acceleration (X and Z), Y direction is ignored
 112 void Player::accelerateHorizontal(v3f target_speed, f32 max_increase)
 113 {
 114         if(max_increase == 0)
 115                 return;
 116
 117         v3f d_wanted = target_speed - m_speed;
 118         d_wanted.Y = 0;
 119         f32 dl = d_wanted.getLength();
 120         if(dl > max_increase)
 121                 dl = max_increase;
 122
 123         v3f d = d_wanted.normalize() * dl;
 124
 125         m_speed.X += d.X;
 126         m_speed.Z += d.Z;
 127
 128 #if 0 // old code
 129         if(m_speed.X < target_speed.X - max_increase)
 130                 m_speed.X += max_increase;
 131         else if(m_speed.X > target_speed.X + max_increase)
 132                 m_speed.X -= max_increase;
 133         else if(m_speed.X < target_speed.X)
 134                 m_speed.X = target_speed.X;
 135         else if(m_speed.X > target_speed.X)
 136                 m_speed.X = target_speed.X;
 137
 138         if(m_speed.Z < target_speed.Z - max_increase)
 139                 m_speed.Z += max_increase;
 140         else if(m_speed.Z > target_speed.Z + max_increase)
 141                 m_speed.Z -= max_increase;
 142         else if(m_speed.Z < target_speed.Z)
 143                 m_speed.Z = target_speed.Z;
 144         else if(m_speed.Z > target_speed.Z)
 145                 m_speed.Z = target_speed.Z;
 146 #endif
 147 }
 148
 149 // Vertical acceleration (Y), X and Z directions are ignored
 150 void Player::accelerateVertical(v3f target_speed, f32 max_increase)
 151 {
 152         if(max_increase == 0)
 153                 return;
 154
 155         f32 d_wanted = target_speed.Y - m_speed.Y;
 156         if(d_wanted > max_increase)
 157                 d_wanted = max_increase;
 158         else if(d_wanted < -max_increase)
 159                 d_wanted = -max_increase;
 160
 161         m_speed.Y += d_wanted;
 162
 163 #if 0 // old code
 164         if(m_speed.Y < target_speed.Y - max_increase)
 165                 m_speed.Y += max_increase;
 166         else if(m_speed.Y > target_speed.Y + max_increase)
 167                 m_speed.Y -= max_increase;
 168         else if(m_speed.Y < target_speed.Y)
 169                 m_speed.Y = target_speed.Y;
 170         else if(m_speed.Y > target_speed.Y)
 171                 m_speed.Y = target_speed.Y;
 172 #endif
 173 }
 174
 175 v3s16 Player::getLightPosition() const
 176 {
 177         return floatToInt(m_position + v3f(0,BS+BS/2,0), BS);
 178 }
 179
 180 void Player::serialize(std::ostream &os)
 181 {
 182         // Utilize a Settings object for storing values
 183         Settings args;
 184         args.setS32("version", 1);
 185         args.set("name", m_name);
 186         //args.set("password", m_password);
 187         args.setFloat("pitch", m_pitch);
 188         args.setFloat("yaw", m_yaw);
 189         args.setV3F("position", m_position);
 190         args.setS32("hp", hp);
 191         args.setS32("breath", m_breath);
 192
 193         args.writeLines(os);
 194
 195         os<<"PlayerArgsEnd\n";
 196
 197         inventory.serialize(os);
 198 }
 199
 200 void Player::deSerialize(std::istream &is, std::string playername)
 201 {
 202         Settings args;
 203
 204         if (!args.parseConfigLines(is, "PlayerArgsEnd")) {
 205                 throw SerializationError("PlayerArgsEnd of player " +
 206                                 playername + " not found!");
 207         }
 208
 209         m_dirty = true;
 210         //args.getS32("version"); // Version field value not used
 211         std::string name = args.get("name");
 212         strlcpy(m_name, name.c_str(), PLAYERNAME_SIZE);
 213         setPitch(args.getFloat("pitch"));
 214         setYaw(args.getFloat("yaw"));
 215         setPosition(args.getV3F("position"));
 216         try{
 217                 hp = args.getS32("hp");
 218         }catch(SettingNotFoundException &e) {
 219                 hp = PLAYER_MAX_HP;
 220         }
 221         try{
 222                 m_breath = args.getS32("breath");
 223         }catch(SettingNotFoundException &e) {
 224                 m_breath = PLAYER_MAX_BREATH;
 225         }
 226
 227         inventory.deSerialize(is);
 228
 229         if(inventory.getList("craftpreview") == NULL) {
 230                 // Convert players without craftpreview
 231                 inventory.addList("craftpreview", 1);
 232
 233                 bool craftresult_is_preview = true;
 234                 if(args.exists("craftresult_is_preview"))
 235                         craftresult_is_preview = args.getBool("craftresult_is_preview");
 236                 if(craftresult_is_preview)
 237                 {
 238                         // Clear craftresult
 239                         inventory.getList("craftresult")->changeItem(0, ItemStack());
 240                 }
 241         }
 242 }
 243
 244 u32 Player::addHud(HudElement *toadd)
 245 {
 246         JMutexAutoLock lock(m_mutex);
 247
 248         u32 id = getFreeHudID();
 249
 250         if (id < hud.size())
 251                 hud[id] = toadd;
 252         else
 253                 hud.push_back(toadd);
 254
 255         return id;
 256 }
 257
 258 HudElement* Player::getHud(u32 id)
 259 {
 260         JMutexAutoLock lock(m_mutex);
 261
 262         if (id < hud.size())
 263                 return hud[id];
 264
 265         return NULL;
 266 }
 267
 268 HudElement* Player::removeHud(u32 id)
 269 {
 270         JMutexAutoLock lock(m_mutex);
 271
 272         HudElement* retval = NULL;
 273         if (id < hud.size()) {
 274                 retval = hud[id];
 275                 hud[id] = NULL;
 276         }
 277         return retval;
 278 }
 279
 280 void Player::clearHud()
 281 {
 282         JMutexAutoLock lock(m_mutex);
 283
 284         while(!hud.empty()) {
 285                 delete hud.back();
 286                 hud.pop_back();
 287         }
 288 }
 289
 290
 291 void RemotePlayer::save(std::string savedir)
 292 {
 293         /*
 294          * We have to open all possible player files in the players directory
 295          * and check their player names because some file systems are not
 296          * case-sensitive and player names are case-sensitive.
 297          */
 298
 299         // A player to deserialize files into to check their names
 300         RemotePlayer testplayer(m_gamedef, "");
 301
 302         savedir += DIR_DELIM;
 303         std::string path = savedir + m_name;
 304         for (u32 i = 0; i < PLAYER_FILE_ALTERNATE_TRIES; i++) {
 305                 if (!fs::PathExists(path)) {
 306                         // Open file and serialize
 307                         std::ostringstream ss(std::ios_base::binary);
 308                         serialize(ss);
 309                         if (!fs::safeWriteToFile(path, ss.str())) {
 310                                 infostream << "Failed to write " << path << std::endl;
 311                         }
 312                         setModified(false);
 313                         return;
 314                 }
 315                 // Open file and deserialize
 316                 std::ifstream is(path.c_str(), std::ios_base::binary);
 317                 if (!is.good()) {
 318                         infostream << "Failed to open " << path << std::endl;
 319                         return;
 320                 }
 321                 testplayer.deSerialize(is, path);
 322                 is.close();
 323                 if (strcmp(testplayer.getName(), m_name) == 0) {
 324                         // Open file and serialize
 325                         std::ostringstream ss(std::ios_base::binary);
 326                         serialize(ss);
 327                         if (!fs::safeWriteToFile(path, ss.str())) {
 328                                 infostream << "Failed to write " << path << std::endl;
 329                         }
 330                         setModified(false);
 331                         return;
 332                 }
 333                 path = savedir + m_name + itos(i);
 334         }
 335
 336         infostream << "Didn't find free file for player " << m_name << std::endl;
 337         return;
 338 }
 339
 340 /*
 341         RemotePlayer
 342 */
 343 void RemotePlayer::setPosition(const v3f &position)
 344 {
 345         Player::setPosition(position);
 346         if(m_sao)
 347                 m_sao->setBasePosition(position);
 348 }
 349