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