]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - src/serverobject.h
Document zoom_fov in settingtypes.txt and minetest.conf.example
[dragonfireclient.git] / src / serverobject.h
index 9e9513a7c2a4e2ca7877d41d4025cd5c906e14b2..597eb63a8180be8bf76fd176a212eb16e6132606 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,11 +58,20 @@ class ServerActiveObject : public ActiveObject
        ServerActiveObject(ServerEnvironment *env, v3f pos);
        virtual ~ServerActiveObject();
 
-       // Call after id has been set and has been inserted in environment
-       virtual void addedToEnvironment();
+       virtual ActiveObjectType getSendType() const
+       { return getType(); }
+
+       // Called after id has been set and has been inserted in environment
+       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);
        
@@ -80,10 +93,7 @@ class ServerActiveObject : public ActiveObject
                { 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";}
        
@@ -103,32 +113,82 @@ class ServerActiveObject : public ActiveObject
                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 void punch(ServerActiveObject *puncher){}
-       virtual void rightClick(ServerActiveObject *clicker){}
+       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() 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 ItemGroupList getArmorGroups()
+       { return ItemGroupList(); }
+       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 std::set<int> getAttachmentChildIds()
+       { return std::set<int>(); }
+       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
@@ -149,12 +209,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;
        
@@ -171,7 +232,7 @@ class ServerActiveObject : public ActiveObject
        /*
                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
@@ -185,7 +246,7 @@ class ServerActiveObject : public ActiveObject
 
 private:
        // Used for creating objects based on type
-       static core::map<u16, Factory> m_types;
+       static std::map<u16, Factory> m_types;
 };
 
 #endif