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