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