ServerRemotePlayer implements ServerActiveObject

[oweals/minetest.git] / src / serverobject.h

diff --git a/src/serverobject.h b/src/serverobject.h
index 5e3afb57b0d08976baa8ba3954e638c45281904d..66118cca021460985eb146e8702f4e4b51f9200d 100644 (file)
--- a/src/serverobject.h
+++ b/src/serverobject.h
@@ -20,7 +20,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #ifndef SERVEROBJECT_HEADER
 #define SERVEROBJECT_HEADER
 
-#include "common_irrlicht.h"
+#include "irrlichttypes.h"
 #include "activeobject.h"
 #include "utility.h"
 
@@ -42,13 +42,20 @@ Some planning
 
 class ServerEnvironment;
 class InventoryItem;
+class Player;
 
 class ServerActiveObject : public ActiveObject
 {
 public:
-       ServerActiveObject(ServerEnvironment *env, u16 id, v3f pos);
+       /*
+               NOTE: m_env can be NULL, but step() isn't called if it is.
+               Prototypes are used that way.
+       */
+       ServerActiveObject(ServerEnvironment *env, v3f pos);
        virtual ~ServerActiveObject();
 
+       virtual void addedToEnvironment(u16 id);
+       
        // Create a certain type of ServerActiveObject
        static ServerActiveObject* create(u8 type,
                        ServerEnvironment *env, u16 id, v3f pos,
@@ -57,18 +64,34 @@ public:
        /*
                Some simple getters/setters
        */
-       v3f getBasePosition()
-               {return m_base_position;}
-       void setBasePosition(v3f pos)
-               {m_base_position = pos;}
-       ServerEnvironment* getEnv()
-               {return m_env;}
+       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)
+               { 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; }
+
        /*
                Step object in time.
                Messages added to messages are sent to client over network.
+
+               send_recommended:
+                       True at around 5-10 times a second, same for all objects.
+                       This is used to let objects send most of the data at the
+                       same time so that the data can be combined in a single
+                       packet.
        */
-       virtual void step(float dtime, Queue<ActiveObjectMessage> &messages){}
+       virtual void step(float dtime, bool send_recommended){}
        
        /*
                The return value of this is passed to the client-side object
@@ -83,8 +106,33 @@ public:
        */
        virtual std::string getStaticData(){return "";}
        
-       // Number of players which know about this object
+       /*
+               Item that the player gets when this object is picked up.
+               If NULL, object cannot be picked up.
+       */
+       virtual InventoryItem* createPickedUpItem(){return NULL;}
+       
+       /*
+               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){}
+
+       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
+               object.
+       */
        u16 m_known_by_count;
+
        /*
                - Whether this object is to be removed when nobody knows about
                  it anymore.
@@ -96,6 +144,16 @@ public:
        */
        bool m_removed;
        
+       /*
+               This is set to true when a block 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, 
+       */
+       bool m_pending_deactivation;
+       
        /*
                Whether the object's static data has been stored to a block
        */
@@ -106,10 +164,15 @@ public:
        */
        v3s16 m_static_block;
        
+       /*
+               Queue of messages to be sent to the client
+       */
+       Queue<ActiveObjectMessage> m_messages_out;
+       
 protected:
        // Used for creating objects based on type
        typedef ServerActiveObject* (*Factory)
-                       (ServerEnvironment *env, u16 id, v3f pos,
+                       (ServerEnvironment *env, v3f pos,
                        const std::string &data);
        static void registerType(u16 type, Factory f);
 
@@ -121,37 +184,5 @@ private:
        static core::map<u16, Factory> m_types;
 };
 
-class TestSAO : public ServerActiveObject
-{
-public:
-       TestSAO(ServerEnvironment *env, u16 id, v3f pos);
-       u8 getType() const
-               {return ACTIVEOBJECT_TYPE_TEST;}
-       static ServerActiveObject* create(ServerEnvironment *env, u16 id, v3f pos,
-                       const std::string &data);
-       void step(float dtime, Queue<ActiveObjectMessage> &messages);
-private:
-       float m_timer1;
-       float m_age;
-};
-
-class ItemSAO : public ServerActiveObject
-{
-public:
-       ItemSAO(ServerEnvironment *env, u16 id, v3f pos,
-                       const std::string inventorystring);
-       u8 getType() const
-               {return ACTIVEOBJECT_TYPE_ITEM;}
-       static ServerActiveObject* create(ServerEnvironment *env, u16 id, v3f pos,
-                       const std::string &data);
-       void step(float dtime, Queue<ActiveObjectMessage> &messages);
-       std::string getClientInitializationData();
-       std::string getStaticData();
-       InventoryItem* createInventoryItem();
-private:
-       std::string m_inventorystring;
-       v3f m_speed_f;
-};
-
 #endif