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