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 #include "inventorymanager.h"
  27
  28 /*
  29
  30 Some planning
  31 -------------
  32
  33 * Server environment adds an active object, which gets the id 1
  34 * The active object list is scanned for each client once in a while,
  35   and it finds out what objects have been added that are not known
  36   by the client yet. This scan is initiated by the Server class and
  37   the result ends up directly to the server.
  38 * A network packet is created with the info and sent to the client.
  39 * Environment converts objects to static data and static data to
  40   objects, based on how close players are to them.
  41
  42 */
  43
  44 class ServerEnvironment;
  45 struct ItemStack;
  46 class Player;
  47 struct ToolCapabilities;
  48
  49 class ServerActiveObject : public ActiveObject
  50 {
  51 public:
  52         /*
  53                 NOTE: m_env can be NULL, but step() isn't called if it is.
  54                 Prototypes are used that way.
  55         */
  56         ServerActiveObject(ServerEnvironment *env, v3f pos);
  57         virtual ~ServerActiveObject();
  58
  59         // Called after id has been set and has been inserted in environment
  60         virtual void addedToEnvironment(){};
  61         // Called before removing from environment
  62         virtual void removingFromEnvironment(){};
  63         // Returns true if object's deletion is the job of the
  64         // environment
  65         virtual bool environmentDeletes() const
  66         { return true; }
  67
  68         virtual bool unlimitedTransferDistance() const
  69         { return false; }
  70
  71         // Create a certain type of ServerActiveObject
  72         static ServerActiveObject* create(u8 type,
  73                         ServerEnvironment *env, u16 id, v3f pos,
  74                         const std::string &data);
  75
  76         /*
  77                 Some simple getters/setters
  78         */
  79         v3f getBasePosition(){ return m_base_position; }
  80         void setBasePosition(v3f pos){ m_base_position = pos; }
  81         ServerEnvironment* getEnv(){ return m_env; }
  82
  83         /*
  84                 Some more dynamic interface
  85         */
  86
  87         virtual void setPos(v3f pos)
  88                 { setBasePosition(pos); }
  89         // continuous: if true, object does not stop immediately at pos
  90         virtual void moveTo(v3f pos, bool continuous)
  91                 { setBasePosition(pos); }
  92         // If object has moved less than this and data has not changed,
  93         // saving to disk may be omitted
  94         virtual float getMinimumSavedMovement()
  95                 { return 2.0*BS; }
  96
  97         virtual bool isPeaceful(){return true;}
  98
  99         virtual std::string getDescription(){return "SAO";}
 100
 101         /*
 102                 Step object in time.
 103                 Messages added to messages are sent to client over network.
 104
 105                 send_recommended:
 106                         True at around 5-10 times a second, same for all objects.
 107                         This is used to let objects send most of the data at the
 108                         same time so that the data can be combined in a single
 109                         packet.
 110         */
 111         virtual void step(float dtime, bool send_recommended){}
 112
 113         /*
 114                 The return value of this is passed to the client-side object
 115                 when it is created
 116         */
 117         virtual std::string getClientInitializationData(){return "";}
 118
 119         /*
 120                 The return value of this is passed to the server-side object
 121                 when it is created (converted from static to active - actually
 122                 the data is the static form)
 123         */
 124         virtual std::string getStaticData()
 125         {
 126                 assert(isStaticAllowed());
 127                 return "";
 128         }
 129         /*
 130                 Return false in here to never save and instead remove object
 131                 on unload. getStaticData() will not be called in that case.
 132         */
 133         virtual bool isStaticAllowed() const
 134         {return true;}
 135
 136         // Returns tool wear
 137         virtual int punch(v3f dir,
 138                         const ToolCapabilities *toolcap=NULL,
 139                         ServerActiveObject *puncher=NULL,
 140                         float time_from_last_punch=1000000)
 141         { return 0; }
 142         virtual void rightClick(ServerActiveObject *clicker)
 143         {}
 144         virtual void setHP(s16 hp)
 145         {}
 146         virtual s16 getHP()
 147         { return 0; }
 148
 149         // Inventory and wielded item
 150         virtual Inventory* getInventory()
 151         { return NULL; }
 152         virtual const Inventory* getInventory() const
 153         { return NULL; }
 154         virtual InventoryLocation getInventoryLocation() const
 155         { return InventoryLocation(); }
 156         virtual void setInventoryModified()
 157         {}
 158         virtual std::string getWieldList() const
 159         { return ""; }
 160         virtual int getWieldIndex() const
 161         { return 0; }
 162         virtual ItemStack getWieldedItem() const;
 163         virtual bool setWieldedItem(const ItemStack &item);
 164
 165         /*
 166                 Number of players which know about this object. Object won't be
 167                 deleted until this is 0 to keep the id preserved for the right
 168                 object.
 169         */
 170         u16 m_known_by_count;
 171
 172         /*
 173                 - Whether this object is to be removed when nobody knows about
 174                   it anymore.
 175                 - Removal is delayed to preserve the id for the time during which
 176                   it could be confused to some other object by some client.
 177                 - This is set to true by the step() method when the object wants
 178                   to be deleted.
 179                 - This can be set to true by anything else too.
 180         */
 181         bool m_removed;
 182
 183         /*
 184                 This is set to true when an object should be removed from the active
 185                 object list but couldn't be removed because the id has to be
 186                 reserved for some client.
 187
 188                 The environment checks this periodically. If this is true and also
 189                 m_known_by_count is true, object is deleted from the active object
 190                 list.
 191         */
 192         bool m_pending_deactivation;
 193
 194         /*
 195                 Whether the object's static data has been stored to a block
 196         */
 197         bool m_static_exists;
 198         /*
 199                 The block from which the object was loaded from, and in which
 200                 a copy of the static data resides.
 201         */
 202         v3s16 m_static_block;
 203
 204         /*
 205                 Queue of messages to be sent to the client
 206         */
 207         Queue<ActiveObjectMessage> m_messages_out;
 208
 209 protected:
 210         // Used for creating objects based on type
 211         typedef ServerActiveObject* (*Factory)
 212                         (ServerEnvironment *env, v3f pos,
 213                         const std::string &data);
 214         static void registerType(u16 type, Factory f);
 215
 216         ServerEnvironment *m_env;
 217         v3f m_base_position;
 218
 219 private:
 220         // Used for creating objects based on type
 221         static core::map<u16, Factory> m_types;
 222 };
 223
 224 #endif
 225