Punchwear (improved) (#8959)

[dragonfireclient.git] / src / serverobject.h

diff --git a/src/serverobject.h b/src/serverobject.h
index 7d87a0f59ba960bccca7989fed8a5eae70ec0602..48689fcb49761c6257f0babf6a0e09869d2ccea8 100644 (file)
--- a/src/serverobject.h
+++ b/src/serverobject.h
@@ -46,6 +46,7 @@ class ServerEnvironment;
 struct ItemStack;
 struct ToolCapabilities;
 struct ObjectProperties;
+struct PlayerHPChangeReason;
 
 class ServerActiveObject : public ActiveObject
 {
@@ -132,51 +133,44 @@ class ServerActiveObject : public ActiveObject
        {return true;}
 
        // Returns tool wear
-       virtual int punch(v3f dir,
-                       const ToolCapabilities *toolcap=NULL,
-                       ServerActiveObject *puncher=NULL,
-                       float time_from_last_punch=1000000)
+       virtual u16 punch(v3f dir,
+                       const ToolCapabilities *toolcap = nullptr,
+                       ServerActiveObject *puncher = nullptr,
+                       float time_from_last_punch = 1000000.0f)
        { return 0; }
        virtual void rightClick(ServerActiveObject *clicker)
        {}
-       virtual void setHP(s16 hp)
+       virtual void setHP(s32 hp, const PlayerHPChangeReason &reason)
        {}
-       virtual s16 getHP() const
+       virtual u16 getHP() const
        { return 0; }
 
        virtual void setArmorGroups(const ItemGroupList &armor_groups)
        {}
-       virtual const ItemGroupList &getArmorGroups()
-       { static const ItemGroupList rv; return rv; }
+       virtual const ItemGroupList &getArmorGroups() const
+       { static ItemGroupList rv; return rv; }
        virtual void setPhysicsOverride(float physics_override_speed, float physics_override_jump, float physics_override_gravity)
        {}
        virtual void setAnimation(v2f frames, float frame_speed, float frame_blend, bool frame_loop)
        {}
        virtual void getAnimation(v2f *frames, float *frame_speed, float *frame_blend, bool *frame_loop)
        {}
+       virtual void setAnimationSpeed(float frame_speed)
+       {}
        virtual void setBonePosition(const std::string &bone, v3f position, v3f rotation)
        {}
        virtual void getBonePosition(const std::string &bone, v3f *position, v3f *lotation)
        {}
-       virtual void setAttachment(int parent_id, const std::string &bone, v3f position, v3f rotation)
-       {}
-       virtual void getAttachment(int *parent_id, std::string *bone, v3f *position, v3f *rotation)
-       {}
-       virtual void addAttachmentChild(int child_id)
-       {}
-       virtual void removeAttachmentChild(int child_id)
-       {}
-       virtual const std::unordered_set<int> &getAttachmentChildIds()
-       { static const std::unordered_set<int> rv; return rv; }
+       virtual const std::unordered_set<int> &getAttachmentChildIds() const
+       { static std::unordered_set<int> rv; return rv; }
+       virtual ServerActiveObject *getParent() const { return nullptr; }
        virtual ObjectProperties* accessObjectProperties()
        { return NULL; }
        virtual void notifyObjectPropertiesModified()
        {}
 
        // Inventory and wielded item
-       virtual Inventory* getInventory()
-       { return NULL; }
-       virtual const Inventory* getInventory() const
+       virtual Inventory *getInventory() const
        { return NULL; }
        virtual InventoryLocation getInventoryLocation() const
        { return InventoryLocation(); }
@@ -184,9 +178,10 @@ class ServerActiveObject : public ActiveObject
        {}
        virtual std::string getWieldList() const
        { return ""; }
-       virtual int getWieldIndex() const
+       virtual u16 getWieldIndex() const
        { return 0; }
-       virtual ItemStack getWieldedItem() const;
+       virtual ItemStack getWieldedItem(ItemStack *selected,
+                       ItemStack *hand = nullptr) const;
        virtual bool setWieldedItem(const ItemStack &item);
        inline void attachParticleSpawner(u32 id)
        {
@@ -210,23 +205,27 @@ class ServerActiveObject : public ActiveObject
                  it anymore.
                - Removal is delayed to preserve the id for the time during which
                  it could be confused to some other object by some client.
-               - This is set to true by the step() method when the object wants
-                 to be deleted.
-               - This can be set to true by anything else too.
+               - This is usually set to true by the step() method when the object wants
+                 to be deleted but can be set by anything else too.
        */
-       bool m_removed = false;
+       bool m_pending_removal = false;
 
        /*
-               This is set to true when an object should be removed from the active
-               object list but couldn't be removed because the id has to be
-               reserved for some client.
+               Same purpose as m_pending_removal but for deactivation.
+               deactvation = save static data in block, remove active object
 
-               The environment checks this periodically. If this is true and also
-               m_known_by_count is true, object is deleted from the active object
-               list.
+               If this is set alongside with m_pending_removal, removal takes
+               priority.
        */
        bool m_pending_deactivation = false;
 
+       /*
+               A getter that unifies the above to answer the question:
+               "Can the environment still interact with this object?"
+       */
+       inline bool isGone() const
+       { return m_pending_removal || m_pending_deactivation; }
+
        /*
                Whether the object's static data has been stored to a block
        */
@@ -243,6 +242,9 @@ class ServerActiveObject : public ActiveObject
        std::queue<ActiveObjectMessage> m_messages_out;
 
 protected:
+       virtual void onAttach(int parent_id) {}
+       virtual void onDetach(int parent_id) {}
+
        // Used for creating objects based on type
        typedef ServerActiveObject* (*Factory)
                        (ServerEnvironment *env, v3f pos,