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