Merge remote branch 'origin/master'
[oweals/minetest.git] / src / serverobject.h
index b901cbf4d122404ce141baf11e6d026932c14f73..7a5b47bd16f671ecf95e43d38c75ee789f482c4a 100644 (file)
@@ -1,18 +1,18 @@
 /*
-Minetest-c55
-Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
+Minetest
+Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
 (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License along
+You should have received a copy of the GNU Lesser General Public License along
 with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
@@ -20,9 +20,11 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #ifndef SERVEROBJECT_HEADER
 #define SERVEROBJECT_HEADER
 
-#include "irrlichttypes.h"
+#include "irrlichttypes_bloated.h"
 #include "activeobject.h"
-#include "utility.h"
+#include "inventorymanager.h"
+#include "itemgroup.h"
+#include "util/container.h"
 
 /*
 
@@ -41,8 +43,10 @@ Some planning
 */
 
 class ServerEnvironment;
-class InventoryItem;
+struct ItemStack;
 class Player;
+struct ToolCapabilities;
+struct ObjectProperties;
 
 class ServerActiveObject : public ActiveObject
 {
@@ -54,10 +58,20 @@ public:
        ServerActiveObject(ServerEnvironment *env, v3f pos);
        virtual ~ServerActiveObject();
 
+       virtual u8 getSendType() const
+       { return getType(); }
+
        // Called after id has been set and has been inserted in environment
-       virtual void addedToEnvironment(){};
+       virtual void addedToEnvironment(u32 dtime_s){};
        // 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,
@@ -82,8 +96,7 @@ public:
                { setBasePosition(pos); }
        // If object has moved less than this and data has not changed,
        // saving to disk may be omitted
-       virtual float getMinimumSavedMovement()
-               { return 2.0*BS; }
+       virtual float getMinimumSavedMovement();
        
        virtual bool isPeaceful(){return true;}
 
@@ -105,37 +118,66 @@ public:
                The return value of this is passed to the client-side object
                when it is created
        */
-       virtual std::string getClientInitializationData(){return "";}
+       virtual std::string getClientInitializationData(u16 protocol_version){return "";}
        
        /*
                The return value of this is passed to the server-side object
                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 "";
+       }
        /*
                Return false in here to never save and instead remove object
                on unload. getStaticData() will not be called in that case.
        */
-       virtual bool isStaticAllowed(){return true;}
-       
-       virtual void punch(ServerActiveObject *puncher){}
-       virtual void rightClick(ServerActiveObject *clicker){}
+       virtual bool isStaticAllowed() const
+       {return true;}
        
-       // Returns a reference
-       virtual InventoryItem* getWieldedItem()
-               { return NULL; }
-       virtual void damageWieldedItem(u16 amount)
-               {}
-       // If all fits, eats item and returns true. Otherwise returns false.
-       virtual bool addToInventory(InventoryItem *item)
-               {return false;}
-       virtual void addToInventoryLater(InventoryItem *item)
-               {}
+       // 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;}
+       {}
+       virtual s16 getHP() const
+       { return 0; }
+
+       virtual void setArmorGroups(const ItemGroupList &armor_groups)
+       {}
+       virtual void setAnimation(v2f frames, float frame_speed, float frame_blend)
+       {}
+       virtual void setBonePosition(std::string bone, v3f position, v3f rotation)
+       {}
+       virtual void setAttachment(int parent_id, std::string bone, v3f position, v3f rotation)
+       {}
+       virtual ObjectProperties* accessObjectProperties()
+       { return NULL; }
+       virtual void notifyObjectPropertiesModified()
+       {}
+
+       // 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);
 
        /*
                Number of players which know about this object. Object won't be
@@ -156,12 +198,13 @@ public:
        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;
        
@@ -192,7 +235,7 @@ protected:
 
 private:
        // Used for creating objects based on type
-       static core::map<u16, Factory> m_types;
+       static std::map<u16, Factory> m_types;
 };
 
 #endif