Add Client::getEnv() and remove some unnecessary wrappers

[minetest.git] / src / serverobject.h

diff --git a/src/serverobject.h b/src/serverobject.h
index 66118cca021460985eb146e8702f4e4b51f9200d..15bbe52f7bbf8e132d2e3497ff3868c434eb4564 100644 (file)
--- a/src/serverobject.h
+++ b/src/serverobject.h
@@ -23,6 +23,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "irrlichttypes.h"
 #include "activeobject.h"
 #include "utility.h"
+#include "inventorymanager.h"
 
 /*
 
@@ -41,8 +42,9 @@ Some planning
 */
 
 class ServerEnvironment;
-class InventoryItem;
+struct ItemStack;
 class Player;
+struct ToolCapabilities;
 
 class ServerActiveObject : public ActiveObject
 {
@@ -54,7 +56,17 @@ class ServerActiveObject : public ActiveObject
        ServerActiveObject(ServerEnvironment *env, v3f pos);
        virtual ~ServerActiveObject();
 
-       virtual void addedToEnvironment(u16 id);
+       // Called after id has been set and has been inserted in environment
+       virtual void addedToEnvironment(){};
+       // Called before removing from environment
+       virtual void removingFromEnvironment(){};
+       // Returns true if object's deletion is the job of the
+       // environment
+       virtual bool environmentDeletes() const
+       { return true; }
+
+       virtual bool unlimitedTransferDistance() const
+       { return false; }
        
        // Create a certain type of ServerActiveObject
        static ServerActiveObject* create(u8 type,
@@ -71,6 +83,7 @@ class ServerActiveObject : public ActiveObject
        /*
                Some more dynamic interface
        */
+       
        virtual void setPos(v3f pos)
                { setBasePosition(pos); }
        // continuous: if true, object does not stop immediately at pos
@@ -80,7 +93,11 @@ class ServerActiveObject : public ActiveObject
        // saving to disk may be omitted
        virtual float getMinimumSavedMovement()
                { return 2.0*BS; }
+       
+       virtual bool isPeaceful(){return true;}
 
+       virtual std::string getDescription(){return "SAO";}
+       
        /*
                Step object in time.
                Messages added to messages are sent to client over network.
@@ -104,28 +121,47 @@ class ServerActiveObject : public ActiveObject
                when it is created (converted from static to active - actually
                the data is the static form)
        */
-       virtual std::string getStaticData(){return "";}
-       
+       virtual std::string getStaticData()
+       {
+               assert(isStaticAllowed());
+               return "";
+       }
        /*
-               Item that the player gets when this object is picked up.
-               If NULL, object cannot be picked up.
+               Return false in here to never save and instead remove object
+               on unload. getStaticData() will not be called in that case.
        */
-       virtual InventoryItem* createPickedUpItem(){return NULL;}
+       virtual bool isStaticAllowed() const
+       {return true;}
        
-       /*
-               If the object doesn't return an item, this will be called.
-               Return value is tool wear.
-       */
-       virtual u16 punch(const std::string &toolname, v3f dir,
-                       const std::string &playername)
-       {return 0;}
-
-       /*
-       */
-       virtual void rightClick(Player *player){}
+       // Returns tool wear
+       virtual int punch(v3f dir,
+                       const ToolCapabilities *toolcap=NULL,
+                       ServerActiveObject *puncher=NULL,
+                       float time_from_last_punch=1000000)
+       { return 0; }
+       virtual void rightClick(ServerActiveObject *clicker)
+       {}
+       virtual void setHP(s16 hp)
+       {}
+       virtual s16 getHP()
+       { return 0; }
+
+       // Inventory and wielded item
+       virtual Inventory* getInventory()
+       { return NULL; }
+       virtual const Inventory* getInventory() const
+       { return NULL; }
+       virtual InventoryLocation getInventoryLocation() const
+       { return InventoryLocation(); }
+       virtual void setInventoryModified()
+       {}
+       virtual std::string getWieldList() const
+       { return ""; }
+       virtual int getWieldIndex() const
+       { return 0; }
+       virtual ItemStack getWieldedItem() const;
+       virtual bool setWieldedItem(const ItemStack &item);
 
-       virtual bool isPeaceful(){return true;}
-       
        /*
                Number of players which know about this object. Object won't be
                deleted until this is 0 to keep the id preserved for the right
@@ -145,12 +181,13 @@ class ServerActiveObject : public ActiveObject
        bool m_removed;
        
        /*
-               This is set to true when a block should be removed from the active
+               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.
 
                The environment checks this periodically. If this is true and also
-               m_known_by_count is true, 
+               m_known_by_count is true, object is deleted from the active object
+               list.
        */
        bool m_pending_deactivation;