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 getAttachment(int *parent_id, std::string *bone, v3f *position, v3f *rotation);
  53         void addAttachmentChild(int child_id);
  54         void removeAttachmentChild(int child_id);
  55         const UNORDERED_SET<int> &getAttachmentChildIds();
  56         ObjectProperties* accessObjectProperties();
  57         void notifyObjectPropertiesModified();
  58 protected:
  59         s16 m_hp;
  60         float m_yaw;
  61
  62         bool m_properties_sent;
  63         struct ObjectProperties m_prop;
  64
  65         ItemGroupList m_armor_groups;
  66         bool m_armor_groups_sent;
  67
  68         v2f m_animation_range;
  69         float m_animation_speed;
  70         float m_animation_blend;
  71         bool m_animation_loop;
  72         bool m_animation_sent;
  73
  74         // Stores position and rotation for each bone name
  75         UNORDERED_MAP<std::string, core::vector2d<v3f> > m_bone_position;
  76         bool m_bone_position_sent;
  77
  78         int m_attachment_parent_id;
  79         UNORDERED_SET<int> m_attachment_child_ids;
  80         std::string m_attachment_bone;
  81         v3f m_attachment_position;
  82         v3f m_attachment_rotation;
  83         bool m_attachment_sent;
  84 };
  85
  86 /*
  87         LuaEntitySAO needs some internals exposed.
  88 */
  89
  90 class LuaEntitySAO : public UnitSAO
  91 {
  92 public:
  93         LuaEntitySAO(ServerEnvironment *env, v3f pos,
  94                      const std::string &name, const std::string &state);
  95         ~LuaEntitySAO();
  96         ActiveObjectType getType() const
  97         { return ACTIVEOBJECT_TYPE_LUAENTITY; }
  98         ActiveObjectType getSendType() const
  99         { return ACTIVEOBJECT_TYPE_GENERIC; }
 100         virtual void addedToEnvironment(u32 dtime_s);
 101         static ServerActiveObject* create(ServerEnvironment *env, v3f pos,
 102                         const std::string &data);
 103         void step(float dtime, bool send_recommended);
 104         std::string getClientInitializationData(u16 protocol_version);
 105         void getStaticData(std::string *result) const;
 106         int punch(v3f dir,
 107                         const ToolCapabilities *toolcap=NULL,
 108                         ServerActiveObject *puncher=NULL,
 109                         float time_from_last_punch=1000000);
 110         void rightClick(ServerActiveObject *clicker);
 111         void setPos(const v3f &pos);
 112         void moveTo(v3f pos, bool continuous);
 113         float getMinimumSavedMovement();
 114         std::string getDescription();
 115         void setHP(s16 hp);
 116         s16 getHP() const;
 117         /* LuaEntitySAO-specific */
 118         void setVelocity(v3f velocity);
 119         v3f getVelocity();
 120         void setAcceleration(v3f acceleration);
 121         v3f getAcceleration();
 122
 123         void setTextureMod(const std::string &mod);
 124         std::string getTextureMod() const;
 125         void setSprite(v2s16 p, int num_frames, float framelength,
 126                         bool select_horiz_by_yawpitch);
 127         std::string getName();
 128         bool getCollisionBox(aabb3f *toset) const;
 129         bool collideWithObjects() const;
 130 private:
 131         std::string getPropertyPacket();
 132         void sendPosition(bool do_interpolate, bool is_movement_end);
 133
 134         std::string m_init_name;
 135         std::string m_init_state;
 136         bool m_registered;
 137
 138         v3f m_velocity;
 139         v3f m_acceleration;
 140
 141         float m_last_sent_yaw;
 142         v3f m_last_sent_position;
 143         v3f m_last_sent_velocity;
 144         float m_last_sent_position_timer;
 145         float m_last_sent_move_precision;
 146         std::string m_current_texture_modifier;
 147 };
 148
 149 /*
 150         PlayerSAO needs some internals exposed.
 151 */
 152
 153 class LagPool
 154 {
 155         float m_pool;
 156         float m_max;
 157 public:
 158         LagPool(): m_pool(15), m_max(15)
 159         {}
 160         void setMax(float new_max)
 161         {
 162                 m_max = new_max;
 163                 if(m_pool > new_max)
 164                         m_pool = new_max;
 165         }
 166         void add(float dtime)
 167         {
 168                 m_pool -= dtime;
 169                 if(m_pool < 0)
 170                         m_pool = 0;
 171         }
 172         bool grab(float dtime)
 173         {
 174                 if(dtime <= 0)
 175                         return true;
 176                 if(m_pool + dtime > m_max)
 177                         return false;
 178                 m_pool += dtime;
 179                 return true;
 180         }
 181 };
 182
 183 typedef UNORDERED_MAP<std::string, std::string> PlayerAttributes;
 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                 Modding interface
 255         */
 256         inline void setExtendedAttribute(const std::string &attr, const std::string &value)
 257         {
 258                 m_extra_attributes[attr] = value;
 259                 m_extended_attributes_modified = true;
 260         }
 261
 262         inline bool getExtendedAttribute(const std::string &attr, std::string *value)
 263         {
 264                 if (m_extra_attributes.find(attr) == m_extra_attributes.end())
 265                         return false;
 266
 267                 *value = m_extra_attributes[attr];
 268                 return true;
 269         }
 270
 271         inline const PlayerAttributes &getExtendedAttributes()
 272         {
 273                 return m_extra_attributes;
 274         }
 275
 276         inline bool extendedAttributesModified() const
 277         {
 278                 return m_extended_attributes_modified;
 279         }
 280
 281         inline void setExtendedAttributeModified(bool v)
 282         {
 283                 m_extended_attributes_modified = v;
 284         }
 285
 286         /*
 287                 PlayerSAO-specific
 288         */
 289
 290         void disconnected();
 291
 292         RemotePlayer *getPlayer() { return m_player; }
 293         u16 getPeerID() const { return m_peer_id; }
 294
 295         // Cheat prevention
 296
 297         v3f getLastGoodPosition() const
 298         {
 299                 return m_last_good_position;
 300         }
 301         float resetTimeFromLastPunch()
 302         {
 303                 float r = m_time_from_last_punch;
 304                 m_time_from_last_punch = 0.0;
 305                 return r;
 306         }
 307         void noCheatDigStart(v3s16 p)
 308         {
 309                 m_nocheat_dig_pos = p;
 310                 m_nocheat_dig_time = 0;
 311         }
 312         v3s16 getNoCheatDigPos()
 313         {
 314                 return m_nocheat_dig_pos;
 315         }
 316         float getNoCheatDigTime()
 317         {
 318                 return m_nocheat_dig_time;
 319         }
 320         void noCheatDigEnd()
 321         {
 322                 m_nocheat_dig_pos = v3s16(32767, 32767, 32767);
 323         }
 324         LagPool& getDigPool()
 325         {
 326                 return m_dig_pool;
 327         }
 328         // Returns true if cheated
 329         bool checkMovementCheat();
 330
 331         // Other
 332
 333         void updatePrivileges(const std::set<std::string> &privs,
 334                         bool is_singleplayer)
 335         {
 336                 m_privs = privs;
 337                 m_is_singleplayer = is_singleplayer;
 338         }
 339
 340         bool getCollisionBox(aabb3f *toset) const;
 341         bool collideWithObjects() const { return true; }
 342
 343         void initialize(RemotePlayer *player, const std::set<std::string> &privs);
 344
 345         v3f getEyePosition() const { return m_base_position + getEyeOffset(); }
 346         v3f getEyeOffset() const;
 347
 348 private:
 349         std::string getPropertyPacket();
 350         void unlinkPlayerSessionAndSave();
 351
 352         RemotePlayer *m_player;
 353         u16 m_peer_id;
 354         Inventory *m_inventory;
 355         s16 m_damage;
 356
 357         // Cheat prevention
 358         LagPool m_dig_pool;
 359         LagPool m_move_pool;
 360         v3f m_last_good_position;
 361         float m_time_from_last_punch;
 362         v3s16 m_nocheat_dig_pos;
 363         float m_nocheat_dig_time;
 364
 365         // Timers
 366         IntervalLimiter m_breathing_interval;
 367         IntervalLimiter m_drowning_interval;
 368
 369         int m_wield_index;
 370         bool m_position_not_sent;
 371
 372         // Cached privileges for enforcement
 373         std::set<std::string> m_privs;
 374         bool m_is_singleplayer;
 375
 376         u16 m_breath;
 377         f32 m_pitch;
 378         f32 m_fov;
 379         s16 m_wanted_range;
 380
 381         PlayerAttributes m_extra_attributes;
 382         bool m_extended_attributes_modified;
 383 public:
 384         float m_physics_override_speed;
 385         float m_physics_override_jump;
 386         float m_physics_override_gravity;
 387         bool m_physics_override_sneak;
 388         bool m_physics_override_sneak_glitch;
 389         bool m_physics_override_sent;
 390 };
 391
 392 #endif