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