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