src/content_sao.h

   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 #ifndef CONTENT_SAO_HEADER
  21 #define CONTENT_SAO_HEADER
  22
  23 #include "serverobject.h"
  24 #include "content_object.h"
  25 #include "itemgroup.h"
  26 #include "player.h"
  27 #include "object_properties.h"
  28
  29 ServerActiveObject* createItemSAO(ServerEnvironment *env, v3f pos,
  30                 const std::string itemstring);
  31
  32 /*
  33         LuaEntitySAO needs some internals exposed.
  34 */
  35
  36 class LuaEntitySAO : public ServerActiveObject
  37 {
  38 public:
  39         LuaEntitySAO(ServerEnvironment *env, v3f pos,
  40                         const std::string &name, const std::string &state);
  41         ~LuaEntitySAO();
  42         u8 getType() const
  43         { return ACTIVEOBJECT_TYPE_LUAENTITY; }
  44         u8 getSendType() const
  45         { return ACTIVEOBJECT_TYPE_GENERIC; }
  46         virtual void addedToEnvironment(u32 dtime_s);
  47         static ServerActiveObject* create(ServerEnvironment *env, v3f pos,
  48                         const std::string &data);
  49         bool isAttached();
  50         void step(float dtime, bool send_recommended);
  51         std::string getClientInitializationData(u16 protocol_version);
  52         std::string getStaticData();
  53         int punch(v3f dir,
  54                         const ToolCapabilities *toolcap=NULL,
  55                         ServerActiveObject *puncher=NULL,
  56                         float time_from_last_punch=1000000);
  57         void rightClick(ServerActiveObject *clicker);
  58         void setPos(v3f pos);
  59         void moveTo(v3f pos, bool continuous);
  60         float getMinimumSavedMovement();
  61         std::string getDescription();
  62         void setHP(s16 hp);
  63         s16 getHP() const;
  64         void setArmorGroups(const ItemGroupList &armor_groups);
  65         void setAnimation(v2f frame_range, float frame_speed, float frame_blend);
  66         void setBonePosition(std::string bone, v3f position, v3f rotation);
  67         void setAttachment(int parent_id, std::string bone, v3f position, v3f rotation);
  68         ObjectProperties* accessObjectProperties();
  69         void notifyObjectPropertiesModified();
  70         /* LuaEntitySAO-specific */
  71         void setVelocity(v3f velocity);
  72         v3f getVelocity();
  73         void setAcceleration(v3f acceleration);
  74         v3f getAcceleration();
  75         void setYaw(float yaw);
  76         float getYaw();
  77         void setTextureMod(const std::string &mod);
  78         void setSprite(v2s16 p, int num_frames, float framelength,
  79                         bool select_horiz_by_yawpitch);
  80         std::string getName();
  81         bool getCollisionBox(aabb3f *toset);
  82         bool collideWithObjects();
  83 private:
  84         std::string getPropertyPacket();
  85         void sendPosition(bool do_interpolate, bool is_movement_end);
  86
  87         std::string m_init_name;
  88         std::string m_init_state;
  89         bool m_registered;
  90         struct ObjectProperties m_prop;
  91
  92         s16 m_hp;
  93         v3f m_velocity;
  94         v3f m_acceleration;
  95         float m_yaw;
  96         ItemGroupList m_armor_groups;
  97
  98         bool m_properties_sent;
  99         float m_last_sent_yaw;
 100         v3f m_last_sent_position;
 101         v3f m_last_sent_velocity;
 102         float m_last_sent_position_timer;
 103         float m_last_sent_move_precision;
 104         bool m_armor_groups_sent;
 105
 106         v2f m_animation_range;
 107         float m_animation_speed;
 108         float m_animation_blend;
 109         bool m_animation_sent;
 110
 111         std::map<std::string, core::vector2d<v3f> > m_bone_position;
 112         bool m_bone_position_sent;
 113
 114         int m_attachment_parent_id;
 115         std::string m_attachment_bone;
 116         v3f m_attachment_position;
 117         v3f m_attachment_rotation;
 118         bool m_attachment_sent;
 119 };
 120
 121 /*
 122         PlayerSAO needs some internals exposed.
 123 */
 124
 125 class LagPool
 126 {
 127         float pool;
 128         float max;
 129 public:
 130         LagPool(): pool(15), max(15)
 131         {}
 132         void setMax(float new_max)
 133         {
 134                 max = new_max;
 135                 if(pool > new_max)
 136                         pool = new_max;
 137         }
 138         void add(float dtime)
 139         {
 140                 pool -= dtime;
 141                 if(pool < 0)
 142                         pool = 0;
 143         }
 144         bool grab(float dtime)
 145         {
 146                 if(dtime <= 0)
 147                         return true;
 148                 if(pool + dtime > max)
 149                         return false;
 150                 pool += dtime;
 151                 return true;
 152         }
 153 };
 154
 155 class PlayerSAO : public ServerActiveObject
 156 {
 157 public:
 158         PlayerSAO(ServerEnvironment *env_, Player *player_, u16 peer_id_,
 159                         const std::set<std::string> &privs, bool is_singleplayer);
 160         ~PlayerSAO();
 161         u8 getType() const
 162         { return ACTIVEOBJECT_TYPE_PLAYER; }
 163         u8 getSendType() const
 164         { return ACTIVEOBJECT_TYPE_GENERIC; }
 165         std::string getDescription();
 166
 167         /*
 168                 Active object <-> environment interface
 169         */
 170
 171         void addedToEnvironment(u32 dtime_s);
 172         void removingFromEnvironment();
 173         bool isStaticAllowed() const;
 174         bool unlimitedTransferDistance() const;
 175         std::string getClientInitializationData(u16 protocol_version);
 176         std::string getStaticData();
 177         bool isAttached();
 178         void step(float dtime, bool send_recommended);
 179         void setBasePosition(const v3f &position);
 180         void setPos(v3f pos);
 181         void moveTo(v3f pos, bool continuous);
 182         void setYaw(float);
 183         void setPitch(float);
 184
 185         /*
 186                 Interaction interface
 187         */
 188
 189         int punch(v3f dir,
 190                 const ToolCapabilities *toolcap,
 191                 ServerActiveObject *puncher,
 192                 float time_from_last_punch);
 193         void rightClick(ServerActiveObject *clicker);
 194         s16 getHP() const;
 195         void setHP(s16 hp);
 196         u16 getBreath() const;
 197         void setBreath(u16 breath);
 198         void setArmorGroups(const ItemGroupList &armor_groups);
 199         void setAnimation(v2f frame_range, float frame_speed, float frame_blend);
 200         void setBonePosition(std::string bone, v3f position, v3f rotation);
 201         void setAttachment(int parent_id, std::string bone, v3f position, v3f rotation);
 202         ObjectProperties* accessObjectProperties();
 203         void notifyObjectPropertiesModified();
 204
 205         /*
 206                 Inventory interface
 207         */
 208
 209         Inventory* getInventory();
 210         const Inventory* getInventory() const;
 211         InventoryLocation getInventoryLocation() const;
 212         void setInventoryModified();
 213         std::string getWieldList() const;
 214         int getWieldIndex() const;
 215         void setWieldIndex(int i);
 216
 217         /*
 218                 PlayerSAO-specific
 219         */
 220
 221         void disconnected();
 222
 223         Player* getPlayer()
 224         {
 225                 return m_player;
 226         }
 227         u16 getPeerID() const
 228         {
 229                 return m_peer_id;
 230         }
 231
 232         // Cheat prevention
 233
 234         v3f getLastGoodPosition() const
 235         {
 236                 return m_last_good_position;
 237         }
 238         float resetTimeFromLastPunch()
 239         {
 240                 float r = m_time_from_last_punch;
 241                 m_time_from_last_punch = 0.0;
 242                 return r;
 243         }
 244         void noCheatDigStart(v3s16 p)
 245         {
 246                 m_nocheat_dig_pos = p;
 247                 m_nocheat_dig_time = 0;
 248         }
 249         v3s16 getNoCheatDigPos()
 250         {
 251                 return m_nocheat_dig_pos;
 252         }
 253         float getNoCheatDigTime()
 254         {
 255                 return m_nocheat_dig_time;
 256         }
 257         void noCheatDigEnd()
 258         {
 259                 m_nocheat_dig_pos = v3s16(32767, 32767, 32767);
 260         }
 261         LagPool& getDigPool()
 262         {
 263                 return m_dig_pool;
 264         }
 265         // Returns true if cheated
 266         bool checkMovementCheat();
 267
 268         // Other
 269
 270         void updatePrivileges(const std::set<std::string> &privs,
 271                         bool is_singleplayer)
 272         {
 273                 m_privs = privs;
 274                 m_is_singleplayer = is_singleplayer;
 275         }
 276
 277         bool getCollisionBox(aabb3f *toset);
 278         bool collideWithObjects();
 279
 280 private:
 281         std::string getPropertyPacket();
 282
 283         Player *m_player;
 284         u16 m_peer_id;
 285         Inventory *m_inventory;
 286
 287         // Cheat prevention
 288         LagPool m_dig_pool;
 289         LagPool m_move_pool;
 290         v3f m_last_good_position;
 291         float m_time_from_last_punch;
 292         v3s16 m_nocheat_dig_pos;
 293         float m_nocheat_dig_time;
 294
 295         int m_wield_index;
 296         bool m_position_not_sent;
 297         ItemGroupList m_armor_groups;
 298         bool m_armor_groups_sent;
 299
 300         bool m_properties_sent;
 301         struct ObjectProperties m_prop;
 302         // Cached privileges for enforcement
 303         std::set<std::string> m_privs;
 304         bool m_is_singleplayer;
 305
 306         v2f m_animation_range;
 307         float m_animation_speed;
 308         float m_animation_blend;
 309         bool m_animation_sent;
 310
 311         std::map<std::string, core::vector2d<v3f> > m_bone_position; // Stores position and rotation for each bone name
 312         bool m_bone_position_sent;
 313
 314         int m_attachment_parent_id;
 315         std::string m_attachment_bone;
 316         v3f m_attachment_position;
 317         v3f m_attachment_rotation;
 318         bool m_attachment_sent;
 319
 320 public:
 321         // Some flags used by Server
 322         bool m_moved;
 323         bool m_inventory_not_sent;
 324         bool m_hp_not_sent;
 325         bool m_breath_not_sent;
 326         bool m_wielded_item_not_sent;
 327
 328         float m_physics_override_speed;
 329         float m_physics_override_jump;
 330         float m_physics_override_gravity;
 331         bool m_physics_override_sent;
 332 };
 333
 334 #endif
 335