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         // Returns a reference
 205         virtual InventoryItem* getWieldedItem();
 206
 207         /* ServerActiveObject interface */
 208
 209         u8 getType() const
 210         {return ACTIVEOBJECT_TYPE_PLAYER;}
 211
 212         // Called after id has been set and has been inserted in environment
 213         void addedToEnvironment();
 214         // Called before removing from environment
 215         void removingFromEnvironment();
 216
 217         bool environmentDeletes() const
 218         { return false; }
 219         bool isStaticAllowed() const
 220         { return false; }
 221
 222         void step(float dtime, bool send_recommended);
 223         std::string getClientInitializationData();
 224         std::string getStaticData();
 225         void punch(ServerActiveObject *puncher, float time_from_last_punch);
 226         void rightClick(ServerActiveObject *clicker);
 227         void setPos(v3f pos);
 228         void moveTo(v3f pos, bool continuous);
 229         virtual std::string getDescription(){return getName();}
 230
 231         virtual void getWieldDiggingProperties(ToolDiggingProperties *dst);
 232         virtual void damageWieldedItem(u16 amount);
 233         // If all fits, eats item and returns true. Otherwise returns false.
 234         virtual bool addToInventory(InventoryItem *item);
 235         virtual void addToInventoryLater(InventoryItem *item);
 236         void clearAddToInventoryLater();
 237         void completeAddToInventoryLater(u16 preferred_index);
 238         virtual void setHP(s16 hp_);
 239         virtual s16 getHP();
 240
 241         v3f m_last_good_position;
 242         float m_last_good_position_age;
 243         std::vector<InventoryItem*> m_additional_items;
 244         bool m_inventory_not_sent;
 245         bool m_hp_not_sent;
 246         bool m_respawn_active;
 247
 248 private:
 249         bool m_is_in_environment;
 250         bool m_position_not_sent;
 251 };
 252
 253 #ifndef SERVER
 254 struct PlayerControl
 255 {
 256         PlayerControl()
 257         {
 258                 up = false;
 259                 down = false;
 260                 left = false;
 261                 right = false;
 262                 jump = false;
 263                 aux1 = false;
 264                 sneak = false;
 265                 pitch = 0;
 266                 yaw = 0;
 267         }
 268         PlayerControl(
 269                 bool a_up,
 270                 bool a_down,
 271                 bool a_left,
 272                 bool a_right,
 273                 bool a_jump,
 274                 bool a_aux1,
 275                 bool a_sneak,
 276                 float a_pitch,
 277                 float a_yaw
 278         )
 279         {
 280                 up = a_up;
 281                 down = a_down;
 282                 left = a_left;
 283                 right = a_right;
 284                 jump = a_jump;
 285                 aux1 = a_aux1;
 286                 sneak = a_sneak;
 287                 pitch = a_pitch;
 288                 yaw = a_yaw;
 289         }
 290         bool up;
 291         bool down;
 292         bool left;
 293         bool right;
 294         bool jump;
 295         bool aux1;
 296         bool sneak;
 297         float pitch;
 298         float yaw;
 299 };
 300
 301 class LocalPlayer : public Player
 302 {
 303 public:
 304         LocalPlayer(IGameDef *gamedef);
 305         virtual ~LocalPlayer();
 306
 307         bool isLocal() const
 308         {
 309                 return true;
 310         }
 311
 312         void move(f32 dtime, Map &map, f32 pos_max_d,
 313                         core::list<CollisionInfo> *collision_info);
 314         void move(f32 dtime, Map &map, f32 pos_max_d);
 315
 316         void applyControl(float dtime);
 317
 318         PlayerControl control;
 319
 320 private:
 321         // This is used for determining the sneaking range
 322         v3s16 m_sneak_node;
 323         // Whether the player is allowed to sneak
 324         bool m_sneak_node_exists;
 325 };
 326 #endif // !SERVER
 327
 328 #endif
 329