src/serverobject.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation; either version 2 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef SERVEROBJECT_HEADER
  21 #define SERVEROBJECT_HEADER
  22
  23 #include "common_irrlicht.h"
  24 #include "activeobject.h"
  25 #include "utility.h"
  26
  27 /*
  28
  29 Some planning
  30 -------------
  31
  32 * Server environment adds an active object, which gets the id 1
  33 * The active object list is scanned for each client once in a while,
  34   and it finds out what objects have been added that are not known
  35   by the client yet. This scan is initiated by the server and the
  36   result ends up directly to the server.
  37 * A network packet is created with the info and sent to the client.
  38
  39 */
  40
  41 class ServerEnvironment;
  42
  43 class ServerActiveObject : public ActiveObject
  44 {
  45 public:
  46         ServerActiveObject(ServerEnvironment *env, u16 id, v3f pos=v3f(0,0,0));
  47         virtual ~ServerActiveObject();
  48
  49         v3f getBasePosition()
  50         {
  51                 return m_base_position;
  52         }
  53
  54         void setBasePosition(v3f pos)
  55         {
  56                 m_base_position = pos;
  57         }
  58
  59         ServerEnvironment* getEnv()
  60         {
  61                 return m_env;
  62         }
  63
  64         /*
  65                 Step object in time.
  66                 Messages added to messages are sent to client over network.
  67         */
  68         virtual void step(float dtime, Queue<ActiveObjectMessage> &messages){}
  69
  70         /*
  71                 The return value of this is passed to the client-side object
  72                 when it is created
  73         */
  74         virtual std::string getClientInitializationData(){return "";}
  75
  76         /*
  77                 The return value of this is passed to the server-side object
  78                 when it is loaded from disk or from a static object
  79         */
  80         virtual std::string getServerInitializationData(){return "";}
  81
  82         /*
  83                 This takes the return value of getServerInitializationData
  84         */
  85         virtual void initialize(const std::string &data){}
  86
  87         // Number of players which know about this object
  88         u16 m_known_by_count;
  89         /*
  90                 - Whether this object is to be removed when nobody knows about
  91                   it anymore.
  92                 - Removal is delayed to preserve the id for the time during which
  93                   it could be confused to some other object by some client.
  94                 - This is set to true by the step() method when the object wants
  95                   to be deleted.
  96         */
  97         bool m_removed;
  98
  99 protected:
 100         ServerEnvironment *m_env;
 101         v3f m_base_position;
 102 };
 103
 104 class TestSAO : public ServerActiveObject
 105 {
 106 public:
 107         TestSAO(ServerEnvironment *env, u16 id, v3f pos);
 108         u8 getType() const
 109         {
 110                 return ACTIVEOBJECT_TYPE_TEST;
 111         }
 112         void step(float dtime, Queue<ActiveObjectMessage> &messages);
 113 private:
 114         float m_timer1;
 115         float m_age;
 116 };
 117
 118 class ItemSAO : public ServerActiveObject
 119 {
 120 public:
 121         ItemSAO(ServerEnvironment *env, u16 id, v3f pos,
 122                         const std::string inventorystring);
 123         u8 getType() const
 124         {
 125                 return ACTIVEOBJECT_TYPE_ITEM;
 126         }
 127         void step(float dtime, Queue<ActiveObjectMessage> &messages);
 128         std::string getClientInitializationData();
 129 private:
 130         std::string m_inventorystring;
 131 };
 132
 133 #endif
 134