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