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 "irrlichttypes.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 class Player;
  46
  47 class ServerActiveObject : public ActiveObject
  48 {
  49 public:
  50         /*
  51                 NOTE: m_env can be NULL, but step() isn't called if it is.
  52                 Prototypes are used that way.
  53         */
  54         ServerActiveObject(ServerEnvironment *env, v3f pos);
  55         virtual ~ServerActiveObject();
  56
  57         virtual void addedToEnvironment(u16 id);
  58
  59         // Create a certain type of ServerActiveObject
  60         static ServerActiveObject* create(u8 type,
  61                         ServerEnvironment *env, u16 id, v3f pos,
  62                         const std::string &data);
  63
  64         /*
  65                 Some simple getters/setters
  66         */
  67         v3f getBasePosition(){ return m_base_position; }
  68         void setBasePosition(v3f pos){ m_base_position = pos; }
  69         ServerEnvironment* getEnv(){ return m_env; }
  70
  71         /*
  72                 Some more dynamic interface
  73         */
  74         virtual void setPos(v3f pos)
  75         { setBasePosition(pos); }
  76         // continuous: if true, object does not stop immediately at pos
  77         virtual void moveTo(v3f pos, bool continuous)
  78         { setBasePosition(pos); }
  79         // If object has moved less than this and data has not changed,
  80         // saving to disk may be omitted
  81         virtual float getMinimumSavedMovement(){ return 2.0*BS; }
  82
  83         /*
  84                 Step object in time.
  85                 Messages added to messages are sent to client over network.
  86
  87                 send_recommended:
  88                         True at around 5-10 times a second, same for all objects.
  89                         This is used to let objects send most of the data at the
  90                         same time so that the data can be combined in a single
  91                         packet.
  92         */
  93         virtual void step(float dtime, bool send_recommended){}
  94
  95         /*
  96                 The return value of this is passed to the client-side object
  97                 when it is created
  98         */
  99         virtual std::string getClientInitializationData(){return "";}
 100
 101         /*
 102                 The return value of this is passed to the server-side object
 103                 when it is created (converted from static to active - actually
 104                 the data is the static form)
 105         */
 106         virtual std::string getStaticData(){return "";}
 107
 108         /*
 109                 Item that the player gets when this object is picked up.
 110                 If NULL, object cannot be picked up.
 111         */
 112         virtual InventoryItem* createPickedUpItem(){return NULL;}
 113
 114         /*
 115                 If the object doesn't return an item, this will be called.
 116                 Return value is tool wear.
 117         */
 118         virtual u16 punch(const std::string &toolname, v3f dir,
 119                         const std::string &playername)
 120         {return 0;}
 121
 122         /*
 123         */
 124         virtual void rightClick(Player *player){}
 125
 126         virtual bool isPeaceful(){return true;}
 127
 128         /*
 129                 Number of players which know about this object. Object won't be
 130                 deleted until this is 0 to keep the id preserved for the right
 131                 object.
 132         */
 133         u16 m_known_by_count;
 134
 135         /*
 136                 - Whether this object is to be removed when nobody knows about
 137                   it anymore.
 138                 - Removal is delayed to preserve the id for the time during which
 139                   it could be confused to some other object by some client.
 140                 - This is set to true by the step() method when the object wants
 141                   to be deleted.
 142                 - This can be set to true by anything else too.
 143         */
 144         bool m_removed;
 145
 146         /*
 147                 This is set to true when a block should be removed from the active
 148                 object list but couldn't be removed because the id has to be
 149                 reserved for some client.
 150
 151                 The environment checks this periodically. If this is true and also
 152                 m_known_by_count is true,
 153         */
 154         bool m_pending_deactivation;
 155
 156         /*
 157                 Whether the object's static data has been stored to a block
 158         */
 159         bool m_static_exists;
 160         /*
 161                 The block from which the object was loaded from, and in which
 162                 a copy of the static data resides.
 163         */
 164         v3s16 m_static_block;
 165
 166         /*
 167                 Queue of messages to be sent to the client
 168         */
 169         Queue<ActiveObjectMessage> m_messages_out;
 170
 171 protected:
 172         // Used for creating objects based on type
 173         typedef ServerActiveObject* (*Factory)
 174                         (ServerEnvironment *env, v3f pos,
 175                         const std::string &data);
 176         static void registerType(u16 type, Factory f);
 177
 178         ServerEnvironment *m_env;
 179         v3f m_base_position;
 180
 181 private:
 182         // Used for creating objects based on type
 183         static core::map<u16, Factory> m_types;
 184 };
 185
 186 #endif
 187