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 class and
  36   the result ends up directly to the server.
  37 * A network packet is created with the info and sent to the client.
  38 * Environment converts objects to static data and static data to
  39   objects, based on how close players are to them.
  40
  41 */
  42
  43 #if 0
  44 class IntervalLimiter
  45 {
  46 public:
  47         IntervalLimiter():
  48                 m_accumulator(0)
  49         {
  50         }
  51         /*
  52                 dtime: time from last call to this method
  53                 wanted_interval: interval wanted
  54                 return value:
  55                         true: action should be skipped
  56                         false: action should be done and dtime has been set
  57         */
  58         bool step(float &dtime, float wanted_interval)
  59         {
  60                 accumulator += dtime;
  61                 if(accumulator < wanted_interval)
  62                 {
  63                         dtime = 0;
  64                         return true;
  65                 }
  66                 accumulator -= wanted-interval;
  67                 dtime = wanted_interval;
  68                 return false;
  69         }
  70 protected:
  71         float m_accumulator;
  72 };
  73 #endif
  74
  75 class ServerEnvironment;
  76 class InventoryItem;
  77
  78 class ServerActiveObject : public ActiveObject
  79 {
  80 public:
  81         /*
  82                 NOTE: m_env can be NULL, but step() isn't called if it is.
  83                 Prototypes are used that way.
  84         */
  85         ServerActiveObject(ServerEnvironment *env, u16 id, v3f pos);
  86         virtual ~ServerActiveObject();
  87
  88         // Create a certain type of ServerActiveObject
  89         static ServerActiveObject* create(u8 type,
  90                         ServerEnvironment *env, u16 id, v3f pos,
  91                         const std::string &data);
  92
  93         /*
  94                 Some simple getters/setters
  95         */
  96         v3f getBasePosition()
  97                 {return m_base_position;}
  98         void setBasePosition(v3f pos)
  99                 {m_base_position = pos;}
 100         ServerEnvironment* getEnv()
 101                 {return m_env;}
 102
 103         /*
 104                 Step object in time.
 105                 Messages added to messages are sent to client over network.
 106
 107                 send_recommended:
 108                         True at around 5-10 times a second, same for all objects.
 109                         This is used to let objects send most of the data at the
 110                         same time so that the data can be combined in a single
 111                         packet.
 112         */
 113         virtual void step(float dtime, Queue<ActiveObjectMessage> &messages,
 114                         bool send_recommended){}
 115
 116         /*
 117                 The return value of this is passed to the client-side object
 118                 when it is created
 119         */
 120         virtual std::string getClientInitializationData(){return "";}
 121
 122         /*
 123                 The return value of this is passed to the server-side object
 124                 when it is created (converted from static to active - actually
 125                 the data is the static form)
 126         */
 127         virtual std::string getStaticData(){return "";}
 128
 129         /*
 130                 Item that the player gets when this object is picked up.
 131                 If NULL, object cannot be picked up.
 132         */
 133         virtual InventoryItem* createPickedUpItem(){return NULL;}
 134
 135         // Number of players which know about this object
 136         u16 m_known_by_count;
 137         /*
 138                 - Whether this object is to be removed when nobody knows about
 139                   it anymore.
 140                 - Removal is delayed to preserve the id for the time during which
 141                   it could be confused to some other object by some client.
 142                 - This is set to true by the step() method when the object wants
 143                   to be deleted.
 144                 - This can be set to true by anything else too.
 145         */
 146         bool m_removed;
 147
 148         /*
 149                 Whether the object's static data has been stored to a block
 150         */
 151         bool m_static_exists;
 152         /*
 153                 The block from which the object was loaded from, and in which
 154                 a copy of the static data resides.
 155         */
 156         v3s16 m_static_block;
 157
 158 protected:
 159         // Used for creating objects based on type
 160         typedef ServerActiveObject* (*Factory)
 161                         (ServerEnvironment *env, u16 id, v3f pos,
 162                         const std::string &data);
 163         static void registerType(u16 type, Factory f);
 164
 165         ServerEnvironment *m_env;
 166         v3f m_base_position;
 167
 168 private:
 169         // Used for creating objects based on type
 170         static core::map<u16, Factory> m_types;
 171 };
 172
 173 class TestSAO : public ServerActiveObject
 174 {
 175 public:
 176         TestSAO(ServerEnvironment *env, u16 id, v3f pos);
 177         u8 getType() const
 178                 {return ACTIVEOBJECT_TYPE_TEST;}
 179         static ServerActiveObject* create(ServerEnvironment *env, u16 id, v3f pos,
 180                         const std::string &data);
 181         void step(float dtime, Queue<ActiveObjectMessage> &messages,
 182                         bool send_recommended);
 183 private:
 184         float m_timer1;
 185         float m_age;
 186 };
 187
 188 class ItemSAO : public ServerActiveObject
 189 {
 190 public:
 191         ItemSAO(ServerEnvironment *env, u16 id, v3f pos,
 192                         const std::string inventorystring);
 193         u8 getType() const
 194                 {return ACTIVEOBJECT_TYPE_ITEM;}
 195         static ServerActiveObject* create(ServerEnvironment *env, u16 id, v3f pos,
 196                         const std::string &data);
 197         void step(float dtime, Queue<ActiveObjectMessage> &messages,
 198                         bool send_recommended);
 199         std::string getClientInitializationData();
 200         std::string getStaticData();
 201         InventoryItem* createInventoryItem();
 202         InventoryItem* createPickedUpItem(){return createInventoryItem();}
 203 private:
 204         std::string m_inventorystring;
 205         v3f m_speed_f;
 206         v3f m_last_sent_position;
 207 };
 208
 209 class RatSAO : public ServerActiveObject
 210 {
 211 public:
 212         RatSAO(ServerEnvironment *env, u16 id, v3f pos);
 213         u8 getType() const
 214                 {return ACTIVEOBJECT_TYPE_RAT;}
 215         static ServerActiveObject* create(ServerEnvironment *env, u16 id, v3f pos,
 216                         const std::string &data);
 217         void step(float dtime, Queue<ActiveObjectMessage> &messages,
 218                         bool send_recommended);
 219         std::string getClientInitializationData();
 220         std::string getStaticData();
 221         InventoryItem* createPickedUpItem();
 222 private:
 223         v3f m_speed_f;
 224         v3f m_oldpos;
 225         v3f m_last_sent_position;
 226         float m_yaw;
 227         float m_counter1;
 228         float m_counter2;
 229         float m_age;
 230         bool m_touching_ground;
 231 };
 232
 233 #endif
 234