src/environment.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 ENVIRONMENT_HEADER
  21 #define ENVIRONMENT_HEADER
  22
  23 /*
  24         This class is the game's environment.
  25         It contains:
  26         - The map
  27         - Players
  28         - Other objects
  29         - The current time in the game (actually it only contains the brightness)
  30         - etc.
  31 */
  32
  33 #include <list>
  34 #include "common_irrlicht.h"
  35 #include "player.h"
  36 #include "map.h"
  37 #include <ostream>
  38 #include "utility.h"
  39
  40 class Environment
  41 {
  42 public:
  43         // Environment will delete the map passed to the constructor
  44         Environment();
  45         virtual ~Environment();
  46
  47         /*
  48                 Step everything in environment.
  49                 - Move players
  50                 - Step mobs
  51                 - Run timers of map
  52         */
  53         virtual void step(f32 dtime) = 0;
  54
  55         virtual Map & getMap() = 0;
  56
  57         virtual void addPlayer(Player *player);
  58         void removePlayer(u16 peer_id);
  59         Player * getPlayer(u16 peer_id);
  60         Player * getPlayer(const char *name);
  61         Player * getRandomConnectedPlayer();
  62         Player * getNearestConnectedPlayer(v3f pos);
  63         core::list<Player*> getPlayers();
  64         core::list<Player*> getPlayers(bool ignore_disconnected);
  65         void printPlayers(std::ostream &o);
  66
  67         //void setDayNightRatio(u32 r);
  68         u32 getDayNightRatio();
  69
  70         // 0-23999
  71         virtual void setTimeOfDay(u32 time)
  72         {
  73                 m_time_of_day = time;
  74         }
  75
  76         u32 getTimeOfDay()
  77         {
  78                 return m_time_of_day;
  79         }
  80
  81 protected:
  82         // peer_ids in here should be unique, except that there may be many 0s
  83         core::list<Player*> m_players;
  84         // Brightness
  85         //u32 m_daynight_ratio;
  86         // Time of day in milli-hours (0-23999); determines day and night
  87         u32 m_time_of_day;
  88 };
  89
  90 /*
  91         List of active blocks, used by ServerEnvironment
  92 */
  93
  94 class ActiveBlockList
  95 {
  96 public:
  97         void update(core::list<v3s16> &active_positions,
  98                         s16 radius,
  99                         core::map<v3s16, bool> &blocks_removed,
 100                         core::map<v3s16, bool> &blocks_added);
 101
 102         bool contains(v3s16 p){
 103                 return (m_list.find(p) != NULL);
 104         }
 105
 106         void clear(){
 107                 m_list.clear();
 108         }
 109
 110         core::map<v3s16, bool> m_list;
 111
 112 private:
 113 };
 114
 115 /*
 116         The server-side environment.
 117
 118         This is not thread-safe. Server uses an environment mutex.
 119 */
 120
 121 #include "serverobject.h"
 122
 123 class Server;
 124 class ActiveBlockModifier;
 125
 126 class ServerEnvironment : public Environment
 127 {
 128 public:
 129         ServerEnvironment(ServerMap *map, Server *server);
 130         ~ServerEnvironment();
 131
 132         Map & getMap()
 133         {
 134                 return *m_map;
 135         }
 136
 137         ServerMap & getServerMap()
 138         {
 139                 return *m_map;
 140         }
 141
 142         Server * getServer()
 143         {
 144                 return m_server;
 145         }
 146
 147         void step(f32 dtime);
 148
 149         /*
 150                 Save players
 151         */
 152         void serializePlayers(const std::string &savedir);
 153         void deSerializePlayers(const std::string &savedir);
 154
 155         /*
 156                 Save and load time of day and game timer
 157         */
 158         void saveMeta(const std::string &savedir);
 159         void loadMeta(const std::string &savedir);
 160
 161         /*
 162                 ActiveObjects
 163                 -------------------------------------------
 164         */
 165
 166         ServerActiveObject* getActiveObject(u16 id);
 167
 168         /*
 169                 Add an active object to the environment.
 170                 Environment handles deletion of object.
 171                 Object may be deleted by environment immediately.
 172                 If id of object is 0, assigns a free id to it.
 173                 Returns the id of the object.
 174                 Returns 0 if not added and thus deleted.
 175         */
 176         u16 addActiveObject(ServerActiveObject *object);
 177
 178         /*
 179                 Find out what new objects have been added to
 180                 inside a radius around a position
 181         */
 182         void getAddedActiveObjects(v3s16 pos, s16 radius,
 183                         core::map<u16, bool> &current_objects,
 184                         core::map<u16, bool> &added_objects);
 185
 186         /*
 187                 Find out what new objects have been removed from
 188                 inside a radius around a position
 189         */
 190         void getRemovedActiveObjects(v3s16 pos, s16 radius,
 191                         core::map<u16, bool> &current_objects,
 192                         core::map<u16, bool> &removed_objects);
 193
 194         /*
 195                 Get the next message emitted by some active object.
 196                 Returns a message with id=0 if no messages are available.
 197         */
 198         ActiveObjectMessage getActiveObjectMessage();
 199
 200         /*
 201                 ActiveBlockModifiers
 202                 -------------------------------------------
 203         */
 204
 205         void addActiveBlockModifier(ActiveBlockModifier *abm);
 206
 207 private:
 208         /*
 209                 Remove all objects that satisfy (m_removed && m_known_by_count==0)
 210         */
 211         void removeRemovedObjects();
 212
 213         /*
 214                 Convert stored objects from block to active
 215         */
 216         void activateObjects(MapBlock *block);
 217
 218         /*
 219                 Convert objects that are not in active blocks to static.
 220
 221                 If m_known_by_count != 0, active object is not deleted, but static
 222                 data is still updated.
 223
 224                 If force_delete is set, active object is deleted nevertheless. It
 225                 shall only be set so in the destructor of the environment.
 226         */
 227         void deactivateFarObjects(bool force_delete);
 228
 229         /*
 230                 Member variables
 231         */
 232
 233         // The map
 234         ServerMap *m_map;
 235         // Pointer to server (which is handling this environment)
 236         Server *m_server;
 237         // Active object list
 238         core::map<u16, ServerActiveObject*> m_active_objects;
 239         // Outgoing network message buffer for active objects
 240         Queue<ActiveObjectMessage> m_active_object_messages;
 241         // Some timers
 242         float m_random_spawn_timer; // used for experimental code
 243         float m_send_recommended_timer;
 244         IntervalLimiter m_object_management_interval;
 245         // List of active blocks
 246         ActiveBlockList m_active_blocks;
 247         IntervalLimiter m_active_blocks_management_interval;
 248         IntervalLimiter m_active_blocks_test_interval;
 249         IntervalLimiter m_active_blocks_nodemetadata_interval;
 250         // Time from the beginning of the game in seconds.
 251         // Incremented in step().
 252         u32 m_game_time;
 253         // A helper variable for incrementing the latter
 254         float m_game_time_fraction_counter;
 255 };
 256
 257 /*
 258         Active block modifier interface.
 259
 260         These are fed into ServerEnvironment at initialization time;
 261         ServerEnvironment handles deleting them.
 262 */
 263
 264 class ActiveBlockModifier
 265 {
 266 public:
 267         ActiveBlockModifier(){};
 268         virtual ~ActiveBlockModifier(){};
 269
 270         //virtual core::list<u8> update(ServerEnvironment *env) = 0;
 271         virtual u32 getTriggerContentCount(){ return 1;}
 272         virtual u8 getTriggerContent(u32 i) = 0;
 273         virtual float getActiveInterval() = 0;
 274         // chance of (1 / return value), 0 is disallowed
 275         virtual u32 getActiveChance() = 0;
 276         // This is called usually at interval for 1/chance of the nodes
 277         virtual void triggerEvent(ServerEnvironment *env, v3s16 p) = 0;
 278 };
 279
 280 #ifndef SERVER
 281
 282 #include "clientobject.h"
 283
 284 /*
 285         The client-side environment.
 286
 287         This is not thread-safe.
 288         Must be called from main (irrlicht) thread (uses the SceneManager)
 289         Client uses an environment mutex.
 290 */
 291
 292 enum ClientEnvEventType
 293 {
 294         CEE_NONE,
 295         CEE_PLAYER_DAMAGE
 296 };
 297
 298 struct ClientEnvEvent
 299 {
 300         ClientEnvEventType type;
 301         union {
 302                 struct{
 303                 } none;
 304                 struct{
 305                         u8 amount;
 306                 } player_damage;
 307         };
 308 };
 309
 310 class ClientEnvironment : public Environment
 311 {
 312 public:
 313         ClientEnvironment(ClientMap *map, scene::ISceneManager *smgr);
 314         ~ClientEnvironment();
 315
 316         Map & getMap()
 317         {
 318                 return *m_map;
 319         }
 320
 321         ClientMap & getClientMap()
 322         {
 323                 return *m_map;
 324         }
 325
 326         void step(f32 dtime);
 327
 328         virtual void addPlayer(Player *player);
 329         LocalPlayer * getLocalPlayer();
 330
 331         void updateMeshes(v3s16 blockpos);
 332         void expireMeshes(bool only_daynight_diffed);
 333
 334         void setTimeOfDay(u32 time)
 335         {
 336                 u32 old_dr = getDayNightRatio();
 337
 338                 Environment::setTimeOfDay(time);
 339
 340                 if(getDayNightRatio() != old_dr)
 341                 {
 342                         dout_client<<DTIME<<"ClientEnvironment: DayNightRatio changed"
 343                                         <<" -> expiring meshes"<<std::endl;
 344                         expireMeshes(true);
 345                 }
 346         }
 347
 348         /*
 349                 ActiveObjects
 350         */
 351
 352         ClientActiveObject* getActiveObject(u16 id);
 353
 354         /*
 355                 Adds an active object to the environment.
 356                 Environment handles deletion of object.
 357                 Object may be deleted by environment immediately.
 358                 If id of object is 0, assigns a free id to it.
 359                 Returns the id of the object.
 360                 Returns 0 if not added and thus deleted.
 361         */
 362         u16 addActiveObject(ClientActiveObject *object);
 363
 364         void addActiveObject(u16 id, u8 type, const std::string &init_data);
 365         void removeActiveObject(u16 id);
 366
 367         void processActiveObjectMessage(u16 id, const std::string &data);
 368
 369         /*
 370                 Callbacks for activeobjects
 371         */
 372
 373         void damageLocalPlayer(u8 damage);
 374
 375         /*
 376                 Client likes to call these
 377         */
 378
 379         // Get all nearby objects
 380         void getActiveObjects(v3f origin, f32 max_d,
 381                         core::array<DistanceSortedActiveObject> &dest);
 382
 383         // Get event from queue. CEE_NONE is returned if queue is empty.
 384         ClientEnvEvent getClientEvent();
 385
 386 private:
 387         ClientMap *m_map;
 388         scene::ISceneManager *m_smgr;
 389         core::map<u16, ClientActiveObject*> m_active_objects;
 390         Queue<ClientEnvEvent> m_client_event_queue;
 391 };
 392
 393 #endif
 394
 395 #endif
 396