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         ServerActiveObject(ServerEnvironment *env, u16 id, v3f pos);
  50         virtual ~ServerActiveObject();
  51
  52         // Create a certain type of ServerActiveObject
  53         static ServerActiveObject* create(u8 type,
  54                         ServerEnvironment *env, u16 id, v3f pos,
  55                         const std::string &data);
  56
  57         /*
  58                 Some simple getters/setters
  59         */
  60         v3f getBasePosition()
  61                 {return m_base_position;}
  62         void setBasePosition(v3f pos)
  63                 {m_base_position = pos;}
  64         ServerEnvironment* getEnv()
  65                 {return m_env;}
  66
  67         /*
  68                 Step object in time.
  69                 Messages added to messages are sent to client over network.
  70         */
  71         virtual void step(float dtime, Queue<ActiveObjectMessage> &messages){}
  72
  73         /*
  74                 The return value of this is passed to the client-side object
  75                 when it is created
  76         */
  77         virtual std::string getClientInitializationData(){return "";}
  78
  79         /*
  80                 The return value of this is passed to the server-side object
  81                 when it is created (converted from static to active - actually
  82                 the data is the static form)
  83         */
  84         virtual std::string getStaticData(){return "";}
  85
  86         // Number of players which know about this object
  87         u16 m_known_by_count;
  88         /*
  89                 - Whether this object is to be removed when nobody knows about
  90                   it anymore.
  91                 - Removal is delayed to preserve the id for the time during which
  92                   it could be confused to some other object by some client.
  93                 - This is set to true by the step() method when the object wants
  94                   to be deleted.
  95                 - This can be set to true by anything else too.
  96         */
  97         bool m_removed;
  98
  99         /*
 100                 Whether the object's static data has been stored to a block
 101         */
 102         bool m_static_exists;
 103         /*
 104                 The block from which the object was loaded from, and in which
 105                 a copy of the static data resides.
 106         */
 107         v3s16 m_static_block;
 108
 109 protected:
 110         // Used for creating objects based on type
 111         typedef ServerActiveObject* (*Factory)
 112                         (ServerEnvironment *env, u16 id, v3f pos,
 113                         const std::string &data);
 114         static void registerType(u16 type, Factory f);
 115
 116         ServerEnvironment *m_env;
 117         v3f m_base_position;
 118
 119 private:
 120         // Used for creating objects based on type
 121         static core::map<u16, Factory> m_types;
 122 };
 123
 124 class TestSAO : public ServerActiveObject
 125 {
 126 public:
 127         TestSAO(ServerEnvironment *env, u16 id, v3f pos);
 128         u8 getType() const
 129                 {return ACTIVEOBJECT_TYPE_TEST;}
 130         static ServerActiveObject* create(ServerEnvironment *env, u16 id, v3f pos,
 131                         const std::string &data);
 132         void step(float dtime, Queue<ActiveObjectMessage> &messages);
 133 private:
 134         float m_timer1;
 135         float m_age;
 136 };
 137
 138 class ItemSAO : public ServerActiveObject
 139 {
 140 public:
 141         ItemSAO(ServerEnvironment *env, u16 id, v3f pos,
 142                         const std::string inventorystring);
 143         u8 getType() const
 144                 {return ACTIVEOBJECT_TYPE_ITEM;}
 145         static ServerActiveObject* create(ServerEnvironment *env, u16 id, v3f pos,
 146                         const std::string &data);
 147         void step(float dtime, Queue<ActiveObjectMessage> &messages);
 148         std::string getClientInitializationData();
 149         std::string getStaticData();
 150         InventoryItem* createInventoryItem();
 151 private:
 152         std::string m_inventorystring;
 153         v3f m_speed_f;
 154 };
 155
 156 #endif
 157