Fix mod channels crash (#7481)
[oweals/minetest.git] / src / content_sao.h
index efbece3cad2273d722a85fba41e01b1cef428215..8510015c562846b96a0a55ce69437448d62a2988 100644 (file)
@@ -17,19 +17,85 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
-#ifndef CONTENT_SAO_HEADER
-#define CONTENT_SAO_HEADER
+#pragma once
 
+#include "network/networkprotocol.h"
+#include "util/numeric.h"
 #include "serverobject.h"
 #include "itemgroup.h"
-#include "player.h"
 #include "object_properties.h"
+#include "constants.h"
+
+class UnitSAO: public ServerActiveObject
+{
+public:
+       UnitSAO(ServerEnvironment *env, v3f pos);
+       virtual ~UnitSAO() = default;
+
+       virtual void setYaw(const float yaw) { m_yaw = yaw; }
+       float getYaw() const { return m_yaw; };
+       f32 getRadYaw() const { return m_yaw * core::DEGTORAD; }
+       // Deprecated
+       f32 getRadYawDep() const { return (m_yaw + 90.) * core::DEGTORAD; }
+
+       s16 getHP() const { return m_hp; }
+       // Use a function, if isDead can be defined by other conditions
+       bool isDead() const { return m_hp == 0; }
+
+       bool isAttached() const;
+       void setArmorGroups(const ItemGroupList &armor_groups);
+       const ItemGroupList &getArmorGroups();
+       void setAnimation(v2f frame_range, float frame_speed, float frame_blend, bool frame_loop);
+       void getAnimation(v2f *frame_range, float *frame_speed, float *frame_blend, bool *frame_loop);
+       void setAnimationSpeed(float frame_speed);
+       void setBonePosition(const std::string &bone, v3f position, v3f rotation);
+       void getBonePosition(const std::string &bone, v3f *position, v3f *rotation);
+       void setAttachment(int parent_id, const std::string &bone, v3f position, v3f rotation);
+       void getAttachment(int *parent_id, std::string *bone, v3f *position, v3f *rotation);
+       void clearChildAttachments();
+       void clearParentAttachment();
+       void addAttachmentChild(int child_id);
+       void removeAttachmentChild(int child_id);
+       const std::unordered_set<int> &getAttachmentChildIds();
+       ObjectProperties* accessObjectProperties();
+       void notifyObjectPropertiesModified();
+protected:
+       s16 m_hp = -1;
+       float m_yaw = 0.0f;
+
+       bool m_properties_sent = true;
+       ObjectProperties m_prop;
+
+       ItemGroupList m_armor_groups;
+       bool m_armor_groups_sent = false;
+
+       v2f m_animation_range;
+       float m_animation_speed = 0.0f;
+       float m_animation_blend = 0.0f;
+       bool m_animation_loop = true;
+       bool m_animation_sent = false;
+       bool m_animation_speed_sent = false;
+
+       // Stores position and rotation for each bone name
+       std::unordered_map<std::string, core::vector2d<v3f>> m_bone_position;
+       bool m_bone_position_sent = false;
+
+       int m_attachment_parent_id = 0;
+       std::unordered_set<int> m_attachment_child_ids;
+       std::string m_attachment_bone = "";
+       v3f m_attachment_position;
+       v3f m_attachment_rotation;
+       bool m_attachment_sent = false;
+private:
+       void onAttach(int parent_id);
+       void onDetach(int parent_id);
+};
 
 /*
        LuaEntitySAO needs some internals exposed.
 */
 
-class LuaEntitySAO : public ServerActiveObject
+class LuaEntitySAO : public UnitSAO
 {
 public:
        LuaEntitySAO(ServerEnvironment *env, v3f pos,
@@ -42,76 +108,57 @@ public:
        virtual void addedToEnvironment(u32 dtime_s);
        static ServerActiveObject* create(ServerEnvironment *env, v3f pos,
                        const std::string &data);
-       bool isAttached();
        void step(float dtime, bool send_recommended);
        std::string getClientInitializationData(u16 protocol_version);
-       std::string getStaticData();
+       bool isStaticAllowed() const
+       { return m_prop.static_save; }
+       void getStaticData(std::string *result) const;
        int punch(v3f dir,
                        const ToolCapabilities *toolcap=NULL,
                        ServerActiveObject *puncher=NULL,
                        float time_from_last_punch=1000000);
        void rightClick(ServerActiveObject *clicker);
-       void setPos(v3f pos);
+       void setPos(const v3f &pos);
        void moveTo(v3f pos, bool continuous);
        float getMinimumSavedMovement();
        std::string getDescription();
-       void setHP(s16 hp);
+       void setHP(s16 hp, const PlayerHPChangeReason &reason);
        s16 getHP() const;
-       void setArmorGroups(const ItemGroupList &armor_groups);
-       void setAnimation(v2f frame_range, float frame_speed, float frame_blend);
-       void setBonePosition(std::string bone, v3f position, v3f rotation);
-       void setAttachment(int parent_id, std::string bone, v3f position, v3f rotation);
-       ObjectProperties* accessObjectProperties();
-       void notifyObjectPropertiesModified();
        /* LuaEntitySAO-specific */
        void setVelocity(v3f velocity);
+       void addVelocity(v3f velocity)
+       {
+               m_velocity += velocity;
+       }
        v3f getVelocity();
        void setAcceleration(v3f acceleration);
        v3f getAcceleration();
-       void setYaw(float yaw);
-       float getYaw();
+
        void setTextureMod(const std::string &mod);
+       std::string getTextureMod() const;
        void setSprite(v2s16 p, int num_frames, float framelength,
                        bool select_horiz_by_yawpitch);
        std::string getName();
-       bool getCollisionBox(aabb3f *toset);
-       bool collideWithObjects();
+       bool getCollisionBox(aabb3f *toset) const;
+       bool getSelectionBox(aabb3f *toset) const;
+       bool collideWithObjects() const;
 private:
        std::string getPropertyPacket();
        void sendPosition(bool do_interpolate, bool is_movement_end);
 
        std::string m_init_name;
        std::string m_init_state;
-       bool m_registered;
-       struct ObjectProperties m_prop;
-       
-       s16 m_hp;
+       bool m_registered = false;
+
        v3f m_velocity;
        v3f m_acceleration;
-       float m_yaw;
-       ItemGroupList m_armor_groups;
-       
-       bool m_properties_sent;
-       float m_last_sent_yaw;
+
+       float m_last_sent_yaw = 0.0f;
        v3f m_last_sent_position;
        v3f m_last_sent_velocity;
-       float m_last_sent_position_timer;
-       float m_last_sent_move_precision;
-       bool m_armor_groups_sent;
-
-       v2f m_animation_range;
-       float m_animation_speed;
-       float m_animation_blend;
-       bool m_animation_sent;
-
-       std::map<std::string, core::vector2d<v3f> > m_bone_position;
-       bool m_bone_position_sent;
-
-       int m_attachment_parent_id;
-       std::string m_attachment_bone;
-       v3f m_attachment_position;
-       v3f m_attachment_rotation;
-       bool m_attachment_sent;
+       float m_last_sent_position_timer = 0.0f;
+       float m_last_sent_move_precision = 0.0f;
+       std::string m_current_texture_modifier = "";
 };
 
 /*
@@ -120,23 +167,30 @@ private:
 
 class LagPool
 {
-       float m_pool;
-       float m_max;
+       float m_pool = 15.0f;
+       float m_max = 15.0f;
 public:
-       LagPool(): m_pool(15), m_max(15)
-       {}
+       LagPool() = default;
+
        void setMax(float new_max)
        {
                m_max = new_max;
                if(m_pool > new_max)
                        m_pool = new_max;
        }
+
        void add(float dtime)
        {
                m_pool -= dtime;
                if(m_pool < 0)
                        m_pool = 0;
        }
+
+       void empty()
+       {
+               m_pool = m_max;
+       }
+
        bool grab(float dtime)
        {
                if(dtime <= 0)
@@ -148,11 +202,13 @@ public:
        }
 };
 
-class PlayerSAO : public ServerActiveObject
+class RemotePlayer;
+
+class PlayerSAO : public UnitSAO
 {
 public:
-       PlayerSAO(ServerEnvironment *env_, Player *player_, u16 peer_id_,
-                       const std::set<std::string> &privs, bool is_singleplayer);
+       PlayerSAO(ServerEnvironment *env_, RemotePlayer *player_, session_t peer_id_,
+                       bool is_singleplayer);
        ~PlayerSAO();
        ActiveObjectType getType() const
        { return ACTIVEOBJECT_TYPE_PLAYER; }
@@ -166,16 +222,27 @@ public:
 
        void addedToEnvironment(u32 dtime_s);
        void removingFromEnvironment();
-       bool isStaticAllowed() const;
+       bool isStaticAllowed() const { return false; }
        std::string getClientInitializationData(u16 protocol_version);
-       std::string getStaticData();
-       bool isAttached();
+       void getStaticData(std::string *result) const;
        void step(float dtime, bool send_recommended);
        void setBasePosition(const v3f &position);
-       void setPos(v3f pos);
+       void setPos(const v3f &pos);
        void moveTo(v3f pos, bool continuous);
-       void setYaw(float);
-       void setPitch(float);
+       void setYaw(const float yaw);
+       // Data should not be sent at player initialization
+       void setYawAndSend(const float yaw);
+       void setPitch(const float pitch);
+       // Data should not be sent at player initialization
+       void setPitchAndSend(const float pitch);
+       f32 getPitch() const { return m_pitch; }
+       f32 getRadPitch() const { return m_pitch * core::DEGTORAD; }
+       // Deprecated
+       f32 getRadPitchDep() const { return -1.0 * m_pitch * core::DEGTORAD; }
+       void setFov(const float pitch);
+       f32 getFov() const { return m_fov; }
+       void setWantedRange(const s16 range);
+       s16 getWantedRange() const { return m_wanted_range; }
 
        /*
                Interaction interface
@@ -185,18 +252,12 @@ public:
                const ToolCapabilities *toolcap,
                ServerActiveObject *puncher,
                float time_from_last_punch);
-       void rightClick(ServerActiveObject *clicker);
-       s16 getHP() const;
-       void setHP(s16 hp);
+       void rightClick(ServerActiveObject *clicker) {}
+       void setHP(s16 hp, const PlayerHPChangeReason &reason);
+       void setHPRaw(s16 hp) { m_hp = hp; }
        s16 readDamage();
-       u16 getBreath() const;
-       void setBreath(u16 breath);
-       void setArmorGroups(const ItemGroupList &armor_groups);
-       void setAnimation(v2f frame_range, float frame_speed, float frame_blend);
-       void setBonePosition(std::string bone, v3f position, v3f rotation);
-       void setAttachment(int parent_id, std::string bone, v3f position, v3f rotation);
-       ObjectProperties* accessObjectProperties();
-       void notifyObjectPropertiesModified();
+       u16 getBreath() const { return m_breath; }
+       void setBreath(const u16 breath, bool send = true);
 
        /*
                Inventory interface
@@ -205,8 +266,10 @@ public:
        Inventory* getInventory();
        const Inventory* getInventory() const;
        InventoryLocation getInventoryLocation() const;
-       void setInventoryModified();
        std::string getWieldList() const;
+       ItemStack getWieldedItem() const;
+       ItemStack getWieldedItemOrHand() const;
+       bool setWieldedItem(const ItemStack &item);
        int getWieldIndex() const;
        void setWieldIndex(int i);
 
@@ -216,14 +279,8 @@ public:
 
        void disconnected();
 
-       Player* getPlayer()
-       {
-               return m_player;
-       }
-       u16 getPeerID() const
-       {
-               return m_peer_id;
-       }
+       RemotePlayer *getPlayer() { return m_player; }
+       session_t getPeerID() const { return m_peer_id; }
 
        // Cheat prevention
 
@@ -237,7 +294,7 @@ public:
                m_time_from_last_punch = 0.0;
                return r;
        }
-       void noCheatDigStart(v3s16 p)
+       void noCheatDigStart(const v3s16 &p)
        {
                m_nocheat_dig_pos = p;
                m_nocheat_dig_time = 0;
@@ -270,64 +327,121 @@ public:
                m_is_singleplayer = is_singleplayer;
        }
 
-       bool getCollisionBox(aabb3f *toset);
-       bool collideWithObjects();
+       bool getCollisionBox(aabb3f *toset) const;
+       bool getSelectionBox(aabb3f *toset) const;
+       bool collideWithObjects() const { return true; }
+
+       void finalize(RemotePlayer *player, const std::set<std::string> &privs);
+
+       v3f getEyePosition() const { return m_base_position + getEyeOffset(); }
+       v3f getEyeOffset() const;
+       float getZoomFOV() const;
+
+       inline Metadata &getMeta() { return m_meta; }
 
 private:
        std::string getPropertyPacket();
-       
-       Player *m_player;
-       u16 m_peer_id;
-       Inventory *m_inventory;
-       s16 m_damage;
+       void unlinkPlayerSessionAndSave();
+
+       RemotePlayer *m_player = nullptr;
+       session_t m_peer_id = 0;
+       Inventory *m_inventory = nullptr;
+       s16 m_damage = 0;
 
        // Cheat prevention
        LagPool m_dig_pool;
        LagPool m_move_pool;
        v3f m_last_good_position;
-       float m_time_from_last_punch;
-       v3s16 m_nocheat_dig_pos;
-       float m_nocheat_dig_time;
+       float m_time_from_last_teleport = 0.0f;
+       float m_time_from_last_punch = 0.0f;
+       v3s16 m_nocheat_dig_pos = v3s16(32767, 32767, 32767);
+       float m_nocheat_dig_time = 0.0f;
 
-       int m_wield_index;
-       bool m_position_not_sent;
-       ItemGroupList m_armor_groups;
-       bool m_armor_groups_sent;
+       // Timers
+       IntervalLimiter m_breathing_interval;
+       IntervalLimiter m_drowning_interval;
+       IntervalLimiter m_node_hurt_interval;
+
+       int m_wield_index = 0;
+       bool m_position_not_sent = false;
 
-       bool m_properties_sent;
-       struct ObjectProperties m_prop;
        // Cached privileges for enforcement
        std::set<std::string> m_privs;
        bool m_is_singleplayer;
 
-       v2f m_animation_range;
-       float m_animation_speed;
-       float m_animation_blend;
-       bool m_animation_sent;
-
-       std::map<std::string, core::vector2d<v3f> > m_bone_position; // Stores position and rotation for each bone name
-       bool m_bone_position_sent;
-
-       int m_attachment_parent_id;
-       std::string m_attachment_bone;
-       v3f m_attachment_position;
-       v3f m_attachment_rotation;
-       bool m_attachment_sent;
+       u16 m_breath = PLAYER_MAX_BREATH_DEFAULT;
+       f32 m_pitch = 0.0f;
+       f32 m_fov = 0.0f;
+       s16 m_wanted_range = 0.0f;
 
+       Metadata m_meta;
 public:
-       // Some flags used by Server
-       bool m_moved;
-       bool m_inventory_not_sent;
-       bool m_breath_not_sent;
-       bool m_wielded_item_not_sent;
-
-       float m_physics_override_speed;
-       float m_physics_override_jump;
-       float m_physics_override_gravity;
-       bool m_physics_override_sneak;
-       bool m_physics_override_sneak_glitch;
-       bool m_physics_override_sent;
+       float m_physics_override_speed = 1.0f;
+       float m_physics_override_jump = 1.0f;
+       float m_physics_override_gravity = 1.0f;
+       bool m_physics_override_sneak = true;
+       bool m_physics_override_sneak_glitch = false;
+       bool m_physics_override_new_move = true;
+       bool m_physics_override_sent = false;
 };
 
-#endif
 
+struct PlayerHPChangeReason {
+       enum Type : u8 {
+               SET_HP,
+               PLAYER_PUNCH,
+               FALL,
+               NODE_DAMAGE,
+               DROWNING,
+               RESPAWN
+       };
+
+       Type type = SET_HP;
+       ServerActiveObject *object;
+       bool from_mod = false;
+       int lua_reference = -1;
+
+       bool setTypeFromString(const std::string &typestr)
+       {
+               if (typestr == "set_hp")
+                       type = SET_HP;
+               else if (typestr == "punch")
+                       type = PLAYER_PUNCH;
+               else if (typestr == "fall")
+                       type = FALL;
+               else if (typestr == "node_damage")
+                       type = NODE_DAMAGE;
+               else if (typestr == "drown")
+                       type = DROWNING;
+               else if (typestr == "respawn")
+                       type = RESPAWN;
+               else
+                       return false;
+
+               return true;
+       }
+
+       std::string getTypeAsString() const
+       {
+               switch (type) {
+               case PlayerHPChangeReason::SET_HP:
+                       return "set_hp";
+               case PlayerHPChangeReason::PLAYER_PUNCH:
+                       return "punch";
+               case PlayerHPChangeReason::FALL:
+                       return "fall";
+               case PlayerHPChangeReason::NODE_DAMAGE:
+                       return "node_damage";
+               case PlayerHPChangeReason::DROWNING:
+                       return "drown";
+               case PlayerHPChangeReason::RESPAWN:
+                       return "respawn";
+               default:
+                       return "?";
+               }
+       }
+
+       PlayerHPChangeReason(Type type, ServerActiveObject *object=NULL):
+                       type(type), object(object)
+       {}
+};