When player times out, log the action as a timeout rather than regular quitting

[minetest.git] / src / serverobject.h

diff --git a/src/serverobject.h b/src/serverobject.h
index a307c421fb0a61c7bd9ccd2203f5143a8c4044ae..cbb50949cf8a4ff0064098fd03cbed5d98d47245 100644 (file)
--- a/src/serverobject.h
+++ b/src/serverobject.h
@@ -32,18 +32,25 @@ Some planning
 * Server environment adds an active object, which gets the id 1
 * The active object list is scanned for each client once in a while,
   and it finds out what objects have been added that are not known
-  by the client yet. This scan is initiated by the server and the
-  result ends up directly to the server.
+  by the client yet. This scan is initiated by the Server class and
+  the result ends up directly to the server.
 * A network packet is created with the info and sent to the client.
+* Environment converts objects to static data and static data to
+  objects, based on how close players are to them.
 
 */
 
 class ServerEnvironment;
 class InventoryItem;
+class Player;
 
 class ServerActiveObject : public ActiveObject
 {
 public:
+       /*
+               NOTE: m_env can be NULL, but step() isn't called if it is.
+               Prototypes are used that way.
+       */
        ServerActiveObject(ServerEnvironment *env, u16 id, v3f pos);
        virtual ~ServerActiveObject();
 
@@ -65,8 +72,14 @@ class ServerActiveObject : public ActiveObject
        /*
                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
@@ -81,8 +94,33 @@ class ServerActiveObject : public ActiveObject
        */
        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.
@@ -94,6 +132,16 @@ class ServerActiveObject : public ActiveObject
        */
        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
        */
@@ -104,6 +152,11 @@ class ServerActiveObject : public ActiveObject
        */
        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)
@@ -119,36 +172,5 @@ class ServerActiveObject : public ActiveObject
        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;
-};
-
 #endif