Fix a memleak pointed by @Zeno- in MeshUpdateQueue
[oweals/minetest.git] / src / serverobject.h
index 4dac4686368fc8bf77bcd465ee795d5ac46d1681..38204980e439b57beda6722863a6d16d73166c97 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,9 @@ Some planning
 */
 
 class ServerEnvironment;
-class InventoryItem;
-class Player;
+struct ItemStack;
+struct ToolCapabilities;
+struct ObjectProperties;
 
 class ServerActiveObject : public ActiveObject
 {
@@ -54,45 +57,45 @@ public:
        ServerActiveObject(ServerEnvironment *env, v3f pos);
        virtual ~ServerActiveObject();
 
+       virtual ActiveObjectType 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; }
-       
+
        // Create a certain type of ServerActiveObject
-       static ServerActiveObject* create(u8 type,
+       static ServerActiveObject* create(ActiveObjectType type,
                        ServerEnvironment *env, u16 id, v3f pos,
                        const std::string &data);
-       
+
        /*
                Some simple getters/setters
        */
        v3f getBasePosition(){ return m_base_position; }
        void setBasePosition(v3f pos){ m_base_position = pos; }
        ServerEnvironment* getEnv(){ return m_env; }
-       
+
        /*
                Some more dynamic interface
        */
-       
-       virtual void setPos(v3f pos)
+
+       virtual void setPos(const v3f &pos)
                { setBasePosition(pos); }
        // continuous: if true, object does not stop immediately at pos
        virtual void moveTo(v3f pos, bool continuous)
                { 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 bool isPeaceful(){return true;}
+       virtual float getMinimumSavedMovement();
 
        virtual std::string getDescription(){return "SAO";}
-       
+
        /*
                Step object in time.
                Messages added to messages are sent to client over network.
@@ -104,22 +107,22 @@ public:
                        packet.
        */
        virtual void step(float dtime, bool send_recommended){}
-       
+
        /*
                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()
+       virtual void getStaticData(std::string *result) const
        {
                assert(isStaticAllowed());
-               return "";
+               *result = "";
        }
        /*
                Return false in here to never save and instead remove object
@@ -127,24 +130,73 @@ public:
        */
        virtual bool isStaticAllowed() const
        {return true;}
-       
-       virtual void punch(ServerActiveObject *puncher){}
-       virtual void rightClick(ServerActiveObject *clicker){}
-       
-       // 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 const ItemGroupList &getArmorGroups()
+       { static const 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 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 UNORDERED_SET<int> &getAttachmentChildIds()
+       { static const UNORDERED_SET<int> rv; return rv; }
+       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);
+       inline void attachParticleSpawner(u32 id)
+       {
+               m_attached_particle_spawners.insert(id);
+       }
+       inline void detachParticleSpawner(u32 id)
+       {
+               m_attached_particle_spawners.erase(id);
+       }
+
 
        /*
                Number of players which know about this object. Object won't be
@@ -163,7 +215,7 @@ public:
                - This can be set to true by anything else too.
        */
        bool m_removed;
-       
+
        /*
                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
@@ -174,7 +226,7 @@ public:
                list.
        */
        bool m_pending_deactivation;
-       
+
        /*
                Whether the object's static data has been stored to a block
        */
@@ -184,12 +236,12 @@ public:
                a copy of the static data resides.
        */
        v3s16 m_static_block;
-       
+
        /*
                Queue of messages to be sent to the client
        */
-       Queue<ActiveObjectMessage> m_messages_out;
-       
+       std::queue<ActiveObjectMessage> m_messages_out;
+
 protected:
        // Used for creating objects based on type
        typedef ServerActiveObject* (*Factory)
@@ -199,10 +251,11 @@ protected:
 
        ServerEnvironment *m_env;
        v3f m_base_position;
+       UNORDERED_SET<u32> m_attached_particle_spawners;
 
 private:
        // Used for creating objects based on type
-       static core::map<u16, Factory> m_types;
+       static std::map<u16, Factory> m_types;
 };
 
 #endif