src/environment.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 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
  30         - etc.
  31 */
  32
  33 #include <set>
  34 #include <list>
  35 #include "irrlichttypes_extrabloated.h"
  36 #include "player.h"
  37 #include <ostream>
  38 #include "activeobject.h"
  39 #include "util/container.h"
  40 #include "util/numeric.h"
  41 #include "mapnode.h"
  42 #include "mapblock.h"
  43
  44 class ServerEnvironment;
  45 class ActiveBlockModifier;
  46 class ServerActiveObject;
  47 typedef struct lua_State lua_State;
  48 class ITextureSource;
  49 class IGameDef;
  50 class Map;
  51 class ServerMap;
  52 class ClientMap;
  53
  54 class Environment
  55 {
  56 public:
  57         // Environment will delete the map passed to the constructor
  58         Environment();
  59         virtual ~Environment();
  60
  61         /*
  62                 Step everything in environment.
  63                 - Move players
  64                 - Step mobs
  65                 - Run timers of map
  66         */
  67         virtual void step(f32 dtime) = 0;
  68
  69         virtual Map & getMap() = 0;
  70
  71         virtual void addPlayer(Player *player);
  72         void removePlayer(u16 peer_id);
  73         Player * getPlayer(u16 peer_id);
  74         Player * getPlayer(const char *name);
  75         Player * getRandomConnectedPlayer();
  76         Player * getNearestConnectedPlayer(v3f pos);
  77         std::list<Player*> getPlayers();
  78         std::list<Player*> getPlayers(bool ignore_disconnected);
  79         void printPlayers(std::ostream &o);
  80
  81         u32 getDayNightRatio();
  82
  83         // 0-23999
  84         virtual void setTimeOfDay(u32 time)
  85         {
  86                 m_time_of_day = time;
  87                 m_time_of_day_f = (float)time / 24000.0;
  88         }
  89
  90         u32 getTimeOfDay()
  91         { return m_time_of_day; }
  92
  93         float getTimeOfDayF()
  94         { return m_time_of_day_f; }
  95
  96         void stepTimeOfDay(float dtime);
  97
  98         void setTimeOfDaySpeed(float speed)
  99         { m_time_of_day_speed = speed; }
 100
 101         float getTimeOfDaySpeed()
 102         { return m_time_of_day_speed; }
 103
 104 protected:
 105         // peer_ids in here should be unique, except that there may be many 0s
 106         std::list<Player*> m_players;
 107         // Time of day in milli-hours (0-23999); determines day and night
 108         u32 m_time_of_day;
 109         // Time of day in 0...1
 110         float m_time_of_day_f;
 111         float m_time_of_day_speed;
 112         // Used to buffer dtime for adding to m_time_of_day
 113         float m_time_counter;
 114 };
 115
 116 /*
 117         Active block modifier interface.
 118
 119         These are fed into ServerEnvironment at initialization time;
 120         ServerEnvironment handles deleting them.
 121 */
 122
 123 class ActiveBlockModifier
 124 {
 125 public:
 126         ActiveBlockModifier(){};
 127         virtual ~ActiveBlockModifier(){};
 128
 129         // Set of contents to trigger on
 130         virtual std::set<std::string> getTriggerContents()=0;
 131         // Set of required neighbors (trigger doesn't happen if none are found)
 132         // Empty = do not check neighbors
 133         virtual std::set<std::string> getRequiredNeighbors()
 134         { return std::set<std::string>(); }
 135         // Trigger interval in seconds
 136         virtual float getTriggerInterval() = 0;
 137         // Random chance of (1 / return value), 0 is disallowed
 138         virtual u32 getTriggerChance() = 0;
 139         // This is called usually at interval for 1/chance of the nodes
 140         virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n){};
 141         virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
 142                         u32 active_object_count, u32 active_object_count_wider){};
 143 };
 144
 145 struct ABMWithState
 146 {
 147         ActiveBlockModifier *abm;
 148         float timer;
 149
 150         ABMWithState(ActiveBlockModifier *abm_);
 151 };
 152
 153 /*
 154         List of active blocks, used by ServerEnvironment
 155 */
 156
 157 class ActiveBlockList
 158 {
 159 public:
 160         void update(std::list<v3s16> &active_positions,
 161                         s16 radius,
 162                         std::set<v3s16> &blocks_removed,
 163                         std::set<v3s16> &blocks_added);
 164
 165         bool contains(v3s16 p){
 166                 return (m_list.find(p) != m_list.end());
 167         }
 168
 169         void clear(){
 170                 m_list.clear();
 171         }
 172
 173         std::set<v3s16> m_list;
 174
 175 private:
 176 };
 177
 178 class IBackgroundBlockEmerger
 179 {
 180 public:
 181         virtual void queueBlockEmerge(v3s16 blockpos, bool allow_generate)=0;
 182 };
 183
 184 /*
 185         The server-side environment.
 186
 187         This is not thread-safe. Server uses an environment mutex.
 188 */
 189
 190 class ServerEnvironment : public Environment
 191 {
 192 public:
 193         ServerEnvironment(ServerMap *map, lua_State *L, IGameDef *gamedef,
 194                         IBackgroundBlockEmerger *emerger);
 195         ~ServerEnvironment();
 196
 197         Map & getMap();
 198
 199         ServerMap & getServerMap();
 200
 201         lua_State* getLua()
 202                 { return m_lua; }
 203
 204         IGameDef *getGameDef()
 205                 { return m_gamedef; }
 206
 207         float getSendRecommendedInterval()
 208                 { return m_recommended_send_interval; }
 209
 210         /*
 211                 Save players
 212         */
 213         void serializePlayers(const std::string &savedir);
 214         void deSerializePlayers(const std::string &savedir);
 215
 216         /*
 217                 Save and load time of day and game timer
 218         */
 219         void saveMeta(const std::string &savedir);
 220         void loadMeta(const std::string &savedir);
 221
 222         /*
 223                 External ActiveObject interface
 224                 -------------------------------------------
 225         */
 226
 227         ServerActiveObject* getActiveObject(u16 id);
 228
 229         /*
 230                 Add an active object to the environment.
 231                 Environment handles deletion of object.
 232                 Object may be deleted by environment immediately.
 233                 If id of object is 0, assigns a free id to it.
 234                 Returns the id of the object.
 235                 Returns 0 if not added and thus deleted.
 236         */
 237         u16 addActiveObject(ServerActiveObject *object);
 238
 239         /*
 240                 Add an active object as a static object to the corresponding
 241                 MapBlock.
 242                 Caller allocates memory, ServerEnvironment frees memory.
 243                 Return value: true if succeeded, false if failed.
 244                 (note:  not used, pending removal from engine)
 245         */
 246         //bool addActiveObjectAsStatic(ServerActiveObject *object);
 247
 248         /*
 249                 Find out what new objects have been added to
 250                 inside a radius around a position
 251         */
 252         void getAddedActiveObjects(v3s16 pos, s16 radius,
 253                         std::set<u16> &current_objects,
 254                         std::set<u16> &added_objects);
 255
 256         /*
 257                 Find out what new objects have been removed from
 258                 inside a radius around a position
 259         */
 260         void getRemovedActiveObjects(v3s16 pos, s16 radius,
 261                         std::set<u16> &current_objects,
 262                         std::set<u16> &removed_objects);
 263
 264         /*
 265                 Get the next message emitted by some active object.
 266                 Returns a message with id=0 if no messages are available.
 267         */
 268         ActiveObjectMessage getActiveObjectMessage();
 269
 270         /*
 271                 Activate objects and dynamically modify for the dtime determined
 272                 from timestamp and additional_dtime
 273         */
 274         void activateBlock(MapBlock *block, u32 additional_dtime=0);
 275
 276         /*
 277                 ActiveBlockModifiers
 278                 -------------------------------------------
 279         */
 280
 281         void addActiveBlockModifier(ActiveBlockModifier *abm);
 282
 283         /*
 284                 Other stuff
 285                 -------------------------------------------
 286         */
 287
 288         // Script-aware node setters
 289         bool setNode(v3s16 p, const MapNode &n);
 290         bool removeNode(v3s16 p);
 291
 292         // Find all active objects inside a radius around a point
 293         std::set<u16> getObjectsInsideRadius(v3f pos, float radius);
 294
 295         // Clear all objects, loading and going through every MapBlock
 296         void clearAllObjects();
 297
 298         // This makes stuff happen
 299         void step(f32 dtime);
 300
 301 private:
 302
 303         /*
 304                 Internal ActiveObject interface
 305                 -------------------------------------------
 306         */
 307
 308         /*
 309                 Add an active object to the environment.
 310
 311                 Called by addActiveObject.
 312
 313                 Object may be deleted by environment immediately.
 314                 If id of object is 0, assigns a free id to it.
 315                 Returns the id of the object.
 316                 Returns 0 if not added and thus deleted.
 317         */
 318         u16 addActiveObjectRaw(ServerActiveObject *object, bool set_changed, u32 dtime_s);
 319
 320         /*
 321                 Remove all objects that satisfy (m_removed && m_known_by_count==0)
 322         */
 323         void removeRemovedObjects();
 324
 325         /*
 326                 Convert stored objects from block to active
 327         */
 328         void activateObjects(MapBlock *block, u32 dtime_s);
 329
 330         /*
 331                 Convert objects that are not in active blocks to static.
 332
 333                 If m_known_by_count != 0, active object is not deleted, but static
 334                 data is still updated.
 335
 336                 If force_delete is set, active object is deleted nevertheless. It
 337                 shall only be set so in the destructor of the environment.
 338         */
 339         void deactivateFarObjects(bool force_delete);
 340
 341         /*
 342                 Member variables
 343         */
 344
 345         // The map
 346         ServerMap *m_map;
 347         // Lua state
 348         lua_State *m_lua;
 349         // Game definition
 350         IGameDef *m_gamedef;
 351         // Background block emerger (the server, in practice)
 352         IBackgroundBlockEmerger *m_emerger;
 353         // Active object list
 354         std::map<u16, ServerActiveObject*> m_active_objects;
 355         // Outgoing network message buffer for active objects
 356         Queue<ActiveObjectMessage> m_active_object_messages;
 357         // Some timers
 358         float m_random_spawn_timer; // used for experimental code
 359         float m_send_recommended_timer;
 360         IntervalLimiter m_object_management_interval;
 361         // List of active blocks
 362         ActiveBlockList m_active_blocks;
 363         IntervalLimiter m_active_blocks_management_interval;
 364         IntervalLimiter m_active_block_modifier_interval;
 365         IntervalLimiter m_active_blocks_nodemetadata_interval;
 366         int m_active_block_interval_overload_skip;
 367         // Time from the beginning of the game in seconds.
 368         // Incremented in step().
 369         u32 m_game_time;
 370         // A helper variable for incrementing the latter
 371         float m_game_time_fraction_counter;
 372         std::list<ABMWithState> m_abms;
 373         // An interval for generally sending object positions and stuff
 374         float m_recommended_send_interval;
 375 };
 376
 377 #ifndef SERVER
 378
 379 #include "clientobject.h"
 380 class ClientSimpleObject;
 381
 382 /*
 383         The client-side environment.
 384
 385         This is not thread-safe.
 386         Must be called from main (irrlicht) thread (uses the SceneManager)
 387         Client uses an environment mutex.
 388 */
 389
 390 enum ClientEnvEventType
 391 {
 392         CEE_NONE,
 393         CEE_PLAYER_DAMAGE
 394 };
 395
 396 struct ClientEnvEvent
 397 {
 398         ClientEnvEventType type;
 399         union {
 400                 struct{
 401                 } none;
 402                 struct{
 403                         u8 amount;
 404                         bool send_to_server;
 405                 } player_damage;
 406         };
 407 };
 408
 409 class ClientEnvironment : public Environment
 410 {
 411 public:
 412         ClientEnvironment(ClientMap *map, scene::ISceneManager *smgr,
 413                         ITextureSource *texturesource, IGameDef *gamedef,
 414                         IrrlichtDevice *device);
 415         ~ClientEnvironment();
 416
 417         Map & getMap();
 418         ClientMap & getClientMap();
 419
 420         IGameDef *getGameDef()
 421         { return m_gamedef; }
 422
 423         void step(f32 dtime);
 424
 425         virtual void addPlayer(Player *player);
 426         LocalPlayer * getLocalPlayer();
 427
 428         /*
 429                 ClientSimpleObjects
 430         */
 431
 432         void addSimpleObject(ClientSimpleObject *simple);
 433
 434         /*
 435                 ActiveObjects
 436         */
 437
 438         ClientActiveObject* getActiveObject(u16 id);
 439
 440         /*
 441                 Adds an active object to the environment.
 442                 Environment handles deletion of object.
 443                 Object may be deleted by environment immediately.
 444                 If id of object is 0, assigns a free id to it.
 445                 Returns the id of the object.
 446                 Returns 0 if not added and thus deleted.
 447         */
 448         u16 addActiveObject(ClientActiveObject *object);
 449
 450         void addActiveObject(u16 id, u8 type, const std::string &init_data);
 451         void removeActiveObject(u16 id);
 452
 453         void processActiveObjectMessage(u16 id, const std::string &data);
 454
 455         /*
 456                 Callbacks for activeobjects
 457         */
 458
 459         void damageLocalPlayer(u8 damage, bool handle_hp=true);
 460
 461         /*
 462                 Client likes to call these
 463         */
 464
 465         // Get all nearby objects
 466         void getActiveObjects(v3f origin, f32 max_d,
 467                         std::vector<DistanceSortedActiveObject> &dest);
 468
 469         // Get event from queue. CEE_NONE is returned if queue is empty.
 470         ClientEnvEvent getClientEvent();
 471
 472         std::vector<core::vector2d<int> > attachment_list; // X is child ID, Y is parent ID
 473
 474 private:
 475         ClientMap *m_map;
 476         scene::ISceneManager *m_smgr;
 477         ITextureSource *m_texturesource;
 478         IGameDef *m_gamedef;
 479         IrrlichtDevice *m_irr;
 480         std::map<u16, ClientActiveObject*> m_active_objects;
 481         std::list<ClientSimpleObject*> m_simple_objects;
 482         Queue<ClientEnvEvent> m_client_event_queue;
 483         IntervalLimiter m_active_object_light_update_interval;
 484         IntervalLimiter m_lava_hurt_interval;
 485 };
 486
 487 #endif
 488
 489 #endif
 490