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