src/serverobject.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 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 Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser 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_bloated.h"
  24 #include "activeobject.h"
  25 #include "inventorymanager.h"
  26 #include "itemgroup.h"
  27 #include "util/container.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 struct ToolCapabilities;
  48 struct ObjectProperties;
  49
  50 class ServerActiveObject : public ActiveObject
  51 {
  52 public:
  53         /*
  54                 NOTE: m_env can be NULL, but step() isn't called if it is.
  55                 Prototypes are used that way.
  56         */
  57         ServerActiveObject(ServerEnvironment *env, v3f pos);
  58         virtual ~ServerActiveObject();
  59
  60         virtual ActiveObjectType getSendType() const
  61         { return getType(); }
  62
  63         // Called after id has been set and has been inserted in environment
  64         virtual void addedToEnvironment(u32 dtime_s){};
  65         // Called before removing from environment
  66         virtual void removingFromEnvironment(){};
  67         // Returns true if object's deletion is the job of the
  68         // environment
  69         virtual bool environmentDeletes() const
  70         { return true; }
  71
  72         // Create a certain type of ServerActiveObject
  73         static ServerActiveObject* create(ActiveObjectType type,
  74                         ServerEnvironment *env, u16 id, v3f pos,
  75                         const std::string &data);
  76
  77         /*
  78                 Some simple getters/setters
  79         */
  80         v3f getBasePosition(){ return m_base_position; }
  81         void setBasePosition(v3f pos){ m_base_position = pos; }
  82         ServerEnvironment* getEnv(){ return m_env; }
  83
  84         /*
  85                 Some more dynamic interface
  86         */
  87
  88         virtual void setPos(const v3f &pos)
  89                 { setBasePosition(pos); }
  90         // continuous: if true, object does not stop immediately at pos
  91         virtual void moveTo(v3f pos, bool continuous)
  92                 { setBasePosition(pos); }
  93         // If object has moved less than this and data has not changed,
  94         // saving to disk may be omitted
  95         virtual float getMinimumSavedMovement();
  96
  97         virtual std::string getDescription(){return "SAO";}
  98
  99         /*
 100                 Step object in time.
 101                 Messages added to messages are sent to client over network.
 102
 103                 send_recommended:
 104                         True at around 5-10 times a second, same for all objects.
 105                         This is used to let objects send most of the data at the
 106                         same time so that the data can be combined in a single
 107                         packet.
 108         */
 109         virtual void step(float dtime, bool send_recommended){}
 110
 111         /*
 112                 The return value of this is passed to the client-side object
 113                 when it is created
 114         */
 115         virtual std::string getClientInitializationData(u16 protocol_version){return "";}
 116
 117         /*
 118                 The return value of this is passed to the server-side object
 119                 when it is created (converted from static to active - actually
 120                 the data is the static form)
 121         */
 122         virtual void getStaticData(std::string *result) const
 123         {
 124                 assert(isStaticAllowed());
 125                 *result = "";
 126         }
 127         /*
 128                 Return false in here to never save and instead remove object
 129                 on unload. getStaticData() will not be called in that case.
 130         */
 131         virtual bool isStaticAllowed() const
 132         {return true;}
 133
 134         // Returns tool wear
 135         virtual int punch(v3f dir,
 136                         const ToolCapabilities *toolcap=NULL,
 137                         ServerActiveObject *puncher=NULL,
 138                         float time_from_last_punch=1000000)
 139         { return 0; }
 140         virtual void rightClick(ServerActiveObject *clicker)
 141         {}
 142         virtual void setHP(s16 hp)
 143         {}
 144         virtual s16 getHP() const
 145         { return 0; }
 146
 147         virtual void setArmorGroups(const ItemGroupList &armor_groups)
 148         {}
 149         virtual const ItemGroupList &getArmorGroups()
 150         { static const ItemGroupList rv; return rv; }
 151         virtual void setPhysicsOverride(float physics_override_speed, float physics_override_jump, float physics_override_gravity)
 152         {}
 153         virtual void setAnimation(v2f frames, float frame_speed, float frame_blend, bool frame_loop)
 154         {}
 155         virtual void getAnimation(v2f *frames, float *frame_speed, float *frame_blend, bool *frame_loop)
 156         {}
 157         virtual void setBonePosition(const std::string &bone, v3f position, v3f rotation)
 158         {}
 159         virtual void getBonePosition(const std::string &bone, v3f *position, v3f *lotation)
 160         {}
 161         virtual void setAttachment(int parent_id, const std::string &bone, v3f position, v3f rotation)
 162         {}
 163         virtual void getAttachment(int *parent_id, std::string *bone, v3f *position, v3f *rotation)
 164         {}
 165         virtual void addAttachmentChild(int child_id)
 166         {}
 167         virtual void removeAttachmentChild(int child_id)
 168         {}
 169         virtual const UNORDERED_SET<int> &getAttachmentChildIds()
 170         { static const UNORDERED_SET<int> rv; return rv; }
 171         virtual ObjectProperties* accessObjectProperties()
 172         { return NULL; }
 173         virtual void notifyObjectPropertiesModified()
 174         {}
 175
 176         // Inventory and wielded item
 177         virtual Inventory* getInventory()
 178         { return NULL; }
 179         virtual const Inventory* getInventory() const
 180         { return NULL; }
 181         virtual InventoryLocation getInventoryLocation() const
 182         { return InventoryLocation(); }
 183         virtual void setInventoryModified()
 184         {}
 185         virtual std::string getWieldList() const
 186         { return ""; }
 187         virtual int getWieldIndex() const
 188         { return 0; }
 189         virtual ItemStack getWieldedItem() const;
 190         virtual bool setWieldedItem(const ItemStack &item);
 191         inline void attachParticleSpawner(u32 id)
 192         {
 193                 m_attached_particle_spawners.insert(id);
 194         }
 195         inline void detachParticleSpawner(u32 id)
 196         {
 197                 m_attached_particle_spawners.erase(id);
 198         }
 199
 200
 201         /*
 202                 Number of players which know about this object. Object won't be
 203                 deleted until this is 0 to keep the id preserved for the right
 204                 object.
 205         */
 206         u16 m_known_by_count;
 207
 208         /*
 209                 - Whether this object is to be removed when nobody knows about
 210                   it anymore.
 211                 - Removal is delayed to preserve the id for the time during which
 212                   it could be confused to some other object by some client.
 213                 - This is set to true by the step() method when the object wants
 214                   to be deleted.
 215                 - This can be set to true by anything else too.
 216         */
 217         bool m_removed;
 218
 219         /*
 220                 This is set to true when an object should be removed from the active
 221                 object list but couldn't be removed because the id has to be
 222                 reserved for some client.
 223
 224                 The environment checks this periodically. If this is true and also
 225                 m_known_by_count is true, object is deleted from the active object
 226                 list.
 227         */
 228         bool m_pending_deactivation;
 229
 230         /*
 231                 Whether the object's static data has been stored to a block
 232         */
 233         bool m_static_exists;
 234         /*
 235                 The block from which the object was loaded from, and in which
 236                 a copy of the static data resides.
 237         */
 238         v3s16 m_static_block;
 239
 240         /*
 241                 Queue of messages to be sent to the client
 242         */
 243         std::queue<ActiveObjectMessage> m_messages_out;
 244
 245 protected:
 246         // Used for creating objects based on type
 247         typedef ServerActiveObject* (*Factory)
 248                         (ServerEnvironment *env, v3f pos,
 249                         const std::string &data);
 250         static void registerType(u16 type, Factory f);
 251
 252         ServerEnvironment *m_env;
 253         v3f m_base_position;
 254         UNORDERED_SET<u32> m_attached_particle_spawners;
 255
 256 private:
 257         // Used for creating objects based on type
 258         static std::map<u16, Factory> m_types;
 259 };
 260
 261 #endif
 262