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