src/player.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010-2011 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 General Public License as published by
   7 the Free Software Foundation; either version 2 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 General Public License for more details.
  14
  15 You should have received a copy of the GNU 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 #ifndef PLAYER_HEADER
  21 #define PLAYER_HEADER
  22
  23 #include "common_irrlicht.h"
  24 #include "inventory.h"
  25 #include "collision.h"
  26
  27 #define PLAYERNAME_SIZE 20
  28
  29 #define PLAYERNAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_"
  30
  31
  32 class Map;
  33 class IGameDef;
  34
  35 class Player
  36 {
  37 public:
  38
  39         Player(IGameDef *gamedef);
  40         virtual ~Player();
  41
  42         void resetInventory();
  43
  44         //void move(f32 dtime, Map &map);
  45         virtual void move(f32 dtime, Map &map, f32 pos_max_d) = 0;
  46
  47         v3f getSpeed()
  48         {
  49                 return m_speed;
  50         }
  51
  52         void setSpeed(v3f speed)
  53         {
  54                 m_speed = speed;
  55         }
  56
  57         // Y direction is ignored
  58         void accelerate(v3f target_speed, f32 max_increase);
  59
  60         v3f getPosition()
  61         {
  62                 return m_position;
  63         }
  64
  65         v3s16 getLightPosition() const;
  66
  67         v3f getEyeOffset()
  68         {
  69                 // This is at the height of the eyes of the current figure
  70                 // return v3f(0, BS+BS/2, 0);
  71                 // This is more like in minecraft
  72                 return v3f(0,BS+(5*BS)/8,0);
  73         }
  74
  75         v3f getEyePosition()
  76         {
  77                 return m_position + getEyeOffset();
  78         }
  79
  80         virtual void setPosition(const v3f &position)
  81         {
  82                 m_position = position;
  83         }
  84
  85         void setPitch(f32 pitch)
  86         {
  87                 m_pitch = pitch;
  88         }
  89
  90         virtual void setYaw(f32 yaw)
  91         {
  92                 m_yaw = yaw;
  93         }
  94
  95         f32 getPitch()
  96         {
  97                 return m_pitch;
  98         }
  99
 100         f32 getYaw()
 101         {
 102                 return m_yaw;
 103         }
 104
 105         virtual void updateName(const char *name)
 106         {
 107                 snprintf(m_name, PLAYERNAME_SIZE, "%s", name);
 108         }
 109
 110         virtual void wieldItem(u16 item);
 111         virtual const InventoryItem *getWieldItem() const
 112         {
 113                 const InventoryList *list = inventory.getList("main");
 114                 if (list)
 115                         return list->getItem(m_selected_item);
 116                 return NULL;
 117         }
 118
 119         const char * getName()
 120         {
 121                 return m_name;
 122         }
 123
 124         virtual bool isLocal() const = 0;
 125
 126         virtual void updateLight(u8 light_at_pos)
 127         {
 128                 light = light_at_pos;
 129         }
 130
 131         // NOTE: Use peer_id == 0 for disconnected
 132         /*virtual bool isClientConnected() { return false; }
 133         virtual void setClientConnected(bool) {}*/
 134
 135         /*
 136                 serialize() writes a bunch of text that can contain
 137                 any characters except a '\0', and such an ending that
 138                 deSerialize stops reading exactly at the right point.
 139         */
 140         void serialize(std::ostream &os);
 141         void deSerialize(std::istream &is);
 142
 143         bool touching_ground;
 144         // This oscillates so that the player jumps a bit above the surface
 145         bool in_water;
 146         // This is more stable and defines the maximum speed of the player
 147         bool in_water_stable;
 148         bool is_climbing;
 149         bool swimming_up;
 150
 151         u8 light;
 152
 153         Inventory inventory;
 154         // Actual inventory is backed up here when creative mode is used
 155         Inventory *inventory_backup;
 156
 157         bool craftresult_is_preview;
 158
 159         u16 hp;
 160
 161         u16 peer_id;
 162
 163 protected:
 164         IGameDef *m_gamedef;
 165
 166         char m_name[PLAYERNAME_SIZE];
 167         u16 m_selected_item;
 168         f32 m_pitch;
 169         f32 m_yaw;
 170         v3f m_speed;
 171         v3f m_position;
 172
 173 public:
 174
 175 };
 176
 177 /*
 178         Player on the server
 179 */
 180
 181 #include "serverobject.h"
 182 #include "content_object.h" // Object type IDs
 183
 184 class PlayerSAO;
 185
 186 class ServerRemotePlayer : public Player, public ServerActiveObject
 187 {
 188 public:
 189         ServerRemotePlayer(ServerEnvironment *env);
 190         ServerRemotePlayer(ServerEnvironment *env, v3f pos_, u16 peer_id_,
 191                         const char *name_);
 192
 193         virtual ~ServerRemotePlayer();
 194
 195         virtual bool isLocal() const
 196         { return false; }
 197
 198         virtual void move(f32 dtime, Map &map, f32 pos_max_d)
 199         {
 200         }
 201
 202         virtual void setPosition(const v3f &position);
 203
 204         void setSAO(PlayerSAO *sao);
 205         PlayerSAO* getSAO();
 206
 207         /* ServerActiveObject interface */
 208
 209         u8 getType() const
 210         {return ACTIVEOBJECT_TYPE_PLAYER;}
 211
 212         virtual void setPos(v3f pos)
 213         {
 214                 setPosition(pos);
 215                 // Movement caused by this command is always valid
 216                 m_last_good_position = pos;
 217                 m_last_good_position_age = 0;
 218         }
 219         virtual void moveTo(v3f pos, bool continuous)
 220         {
 221                 setPosition(pos);
 222                 // Movement caused by this command is always valid
 223                 m_last_good_position = pos;
 224                 m_last_good_position_age = 0;
 225         }
 226
 227         virtual std::string getDescription(){return getName();}
 228         // Returns a reference
 229         virtual InventoryItem* getWieldedItem();
 230         virtual void damageWieldedItem(u16 amount);
 231         // If all fits, eats item and returns true. Otherwise returns false.
 232         virtual bool addToInventory(InventoryItem *item);
 233         virtual void addToInventoryLater(InventoryItem *item);
 234         void clearAddToInventoryLater();
 235         void completeAddToInventoryLater(u16 preferred_index);
 236         virtual void setHP(s16 hp_);
 237         virtual s16 getHP();
 238
 239         v3f m_last_good_position;
 240         float m_last_good_position_age;
 241         std::vector<InventoryItem*> m_additional_items;
 242         bool m_inventory_not_sent;
 243         bool m_hp_not_sent;
 244
 245 private:
 246
 247         PlayerSAO *m_sao;
 248 };
 249
 250 #ifndef SERVER
 251
 252 #if 0
 253 /*
 254         All the other players on the client are these
 255 */
 256
 257 class RemotePlayer : public Player, public scene::ISceneNode
 258 {
 259 public:
 260         RemotePlayer(
 261                 IGameDef *gamedef,
 262                 scene::ISceneNode* parent=NULL,
 263                 IrrlichtDevice *device=NULL,
 264                 s32 id=0);
 265
 266         virtual ~RemotePlayer();
 267
 268         /*
 269                 ISceneNode methods
 270         */
 271
 272         virtual void OnRegisterSceneNode()
 273         {
 274                 if (IsVisible)
 275                         SceneManager->registerNodeForRendering(this);
 276
 277                 ISceneNode::OnRegisterSceneNode();
 278         }
 279
 280         virtual void render()
 281         {
 282                 // Do nothing
 283         }
 284
 285         virtual const core::aabbox3d<f32>& getBoundingBox() const
 286         {
 287                 return m_box;
 288         }
 289
 290         void setPosition(const v3f &position)
 291         {
 292                 m_oldpos = m_showpos;
 293
 294                 if(m_pos_animation_time < 0.001 || m_pos_animation_time > 1.0)
 295                         m_pos_animation_time = m_pos_animation_time_counter;
 296                 else
 297                         m_pos_animation_time = m_pos_animation_time * 0.9
 298                                         + m_pos_animation_time_counter * 0.1;
 299                 m_pos_animation_time_counter = 0;
 300                 m_pos_animation_counter = 0;
 301
 302                 Player::setPosition(position);
 303                 //ISceneNode::setPosition(position);
 304         }
 305
 306         virtual void setYaw(f32 yaw)
 307         {
 308                 Player::setYaw(yaw);
 309                 ISceneNode::setRotation(v3f(0, -yaw, 0));
 310         }
 311
 312         bool isLocal() const
 313         {
 314                 return false;
 315         }
 316
 317         void updateName(const char *name);
 318
 319         virtual void updateLight(u8 light_at_pos)
 320         {
 321                 Player::updateLight(light_at_pos);
 322
 323                 if(m_node == NULL)
 324                         return;
 325
 326                 u8 li = decode_light(light_at_pos);
 327                 video::SColor color(255,li,li,li);
 328                 setMeshVerticesColor(m_node->getMesh(), color);
 329         }
 330
 331         void move(f32 dtime, Map &map, f32 pos_max_d);
 332
 333 private:
 334         scene::IMeshSceneNode *m_node;
 335         scene::ITextSceneNode* m_text;
 336         core::aabbox3d<f32> m_box;
 337
 338         v3f m_oldpos;
 339         f32 m_pos_animation_counter;
 340         f32 m_pos_animation_time;
 341         f32 m_pos_animation_time_counter;
 342         v3f m_showpos;
 343 };
 344 #endif
 345
 346 #endif // !SERVER
 347
 348 #ifndef SERVER
 349 struct PlayerControl
 350 {
 351         PlayerControl()
 352         {
 353                 up = false;
 354                 down = false;
 355                 left = false;
 356                 right = false;
 357                 jump = false;
 358                 aux1 = false;
 359                 sneak = false;
 360                 pitch = 0;
 361                 yaw = 0;
 362         }
 363         PlayerControl(
 364                 bool a_up,
 365                 bool a_down,
 366                 bool a_left,
 367                 bool a_right,
 368                 bool a_jump,
 369                 bool a_aux1,
 370                 bool a_sneak,
 371                 float a_pitch,
 372                 float a_yaw
 373         )
 374         {
 375                 up = a_up;
 376                 down = a_down;
 377                 left = a_left;
 378                 right = a_right;
 379                 jump = a_jump;
 380                 aux1 = a_aux1;
 381                 sneak = a_sneak;
 382                 pitch = a_pitch;
 383                 yaw = a_yaw;
 384         }
 385         bool up;
 386         bool down;
 387         bool left;
 388         bool right;
 389         bool jump;
 390         bool aux1;
 391         bool sneak;
 392         float pitch;
 393         float yaw;
 394 };
 395
 396 class LocalPlayer : public Player
 397 {
 398 public:
 399         LocalPlayer(IGameDef *gamedef);
 400         virtual ~LocalPlayer();
 401
 402         bool isLocal() const
 403         {
 404                 return true;
 405         }
 406
 407         void move(f32 dtime, Map &map, f32 pos_max_d,
 408                         core::list<CollisionInfo> *collision_info);
 409         void move(f32 dtime, Map &map, f32 pos_max_d);
 410
 411         void applyControl(float dtime);
 412
 413         PlayerControl control;
 414
 415 private:
 416         // This is used for determining the sneaking range
 417         v3s16 m_sneak_node;
 418         // Whether the player is allowed to sneak
 419         bool m_sneak_node_exists;
 420 };
 421 #endif // !SERVER
 422
 423 #endif
 424