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 <queue>
  36 #include <map>
  37 #include "irr_v3d.h"
  38 #include "activeobject.h"
  39 #include "util/numeric.h"
  40 #include "mapnode.h"
  41 #include "mapblock.h"
  42 #include "threading/mutex.h"
  43 #include "network/networkprotocol.h" // for AccessDeniedCode
  44
  45 class ServerEnvironment;
  46 class ActiveBlockModifier;
  47 class ServerActiveObject;
  48 class ITextureSource;
  49 class IGameDef;
  50 class Map;
  51 class ServerMap;
  52 class ClientMap;
  53 class GameScripting;
  54 class Player;
  55 class RemotePlayer;
  56
  57 class Environment
  58 {
  59 public:
  60         // Environment will delete the map passed to the constructor
  61         Environment();
  62         virtual ~Environment();
  63
  64         /*
  65                 Step everything in environment.
  66                 - Move players
  67                 - Step mobs
  68                 - Run timers of map
  69         */
  70         virtual void step(f32 dtime) = 0;
  71
  72         virtual Map & getMap() = 0;
  73
  74         virtual void addPlayer(Player *player);
  75         void removePlayer(Player *player);
  76         Player * getPlayer(u16 peer_id);
  77         Player * getPlayer(const char *name);
  78         Player * getRandomConnectedPlayer();
  79         Player * getNearestConnectedPlayer(v3f pos);
  80         std::vector<Player*> getPlayers();
  81         std::vector<Player*> getPlayers(bool ignore_disconnected);
  82
  83         u32 getDayNightRatio();
  84
  85         // 0-23999
  86         virtual void setTimeOfDay(u32 time);
  87         u32 getTimeOfDay();
  88         float getTimeOfDayF();
  89
  90         void stepTimeOfDay(float dtime);
  91
  92         void setTimeOfDaySpeed(float speed);
  93         float getTimeOfDaySpeed();
  94
  95         void setDayNightRatioOverride(bool enable, u32 value)
  96         {
  97                 m_enable_day_night_ratio_override = enable;
  98                 m_day_night_ratio_override = value;
  99         }
 100
 101         // counter used internally when triggering ABMs
 102         u32 m_added_objects;
 103
 104 protected:
 105         // peer_ids in here should be unique, except that there may be many 0s
 106         std::vector<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         // Overriding the day-night ratio is useful for custom sky visuals
 115         bool m_enable_day_night_ratio_override;
 116         u32 m_day_night_ratio_override;
 117
 118         /* TODO: Add a callback function so these can be updated when a setting
 119          *       changes.  At this point in time it doesn't matter (e.g. /set
 120          *       is documented to change server settings only)
 121          *
 122          * TODO: Local caching of settings is not optimal and should at some stage
 123          *       be updated to use a global settings object for getting thse values
 124          *       (as opposed to the this local caching). This can be addressed in
 125          *       a later release.
 126          */
 127         bool m_cache_enable_shaders;
 128
 129 private:
 130         Mutex m_timeofday_lock;
 131         Mutex m_time_lock;
 132
 133 };
 134
 135 /*
 136         Active block modifier interface.
 137
 138         These are fed into ServerEnvironment at initialization time;
 139         ServerEnvironment handles deleting them.
 140 */
 141
 142 class ActiveBlockModifier
 143 {
 144 public:
 145         ActiveBlockModifier(){};
 146         virtual ~ActiveBlockModifier(){};
 147
 148         // Set of contents to trigger on
 149         virtual std::set<std::string> getTriggerContents()=0;
 150         // Set of required neighbors (trigger doesn't happen if none are found)
 151         // Empty = do not check neighbors
 152         virtual std::set<std::string> getRequiredNeighbors()
 153         { return std::set<std::string>(); }
 154         // Trigger interval in seconds
 155         virtual float getTriggerInterval() = 0;
 156         // Random chance of (1 / return value), 0 is disallowed
 157         virtual u32 getTriggerChance() = 0;
 158         // This is called usually at interval for 1/chance of the nodes
 159         virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n){};
 160         virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
 161                         u32 active_object_count, u32 active_object_count_wider){};
 162 };
 163
 164 struct ABMWithState
 165 {
 166         ActiveBlockModifier *abm;
 167         float timer;
 168
 169         ABMWithState(ActiveBlockModifier *abm_);
 170 };
 171
 172 /*
 173         List of active blocks, used by ServerEnvironment
 174 */
 175
 176 class ActiveBlockList
 177 {
 178 public:
 179         void update(std::vector<v3s16> &active_positions,
 180                         s16 radius,
 181                         std::set<v3s16> &blocks_removed,
 182                         std::set<v3s16> &blocks_added);
 183
 184         bool contains(v3s16 p){
 185                 return (m_list.find(p) != m_list.end());
 186         }
 187
 188         void clear(){
 189                 m_list.clear();
 190         }
 191
 192         std::set<v3s16> m_list;
 193         std::set<v3s16> m_forceloaded_list;
 194
 195 private:
 196 };
 197
 198 /*
 199         The server-side environment.
 200
 201         This is not thread-safe. Server uses an environment mutex.
 202 */
 203
 204 class ServerEnvironment : public Environment
 205 {
 206 public:
 207         ServerEnvironment(ServerMap *map, GameScripting *scriptIface,
 208                         IGameDef *gamedef, const std::string &path_world);
 209         ~ServerEnvironment();
 210
 211         Map & getMap();
 212
 213         ServerMap & getServerMap();
 214
 215         //TODO find way to remove this fct!
 216         GameScripting* getScriptIface()
 217                 { return m_script; }
 218
 219         IGameDef *getGameDef()
 220                 { return m_gamedef; }
 221
 222         float getSendRecommendedInterval()
 223                 { return m_recommended_send_interval; }
 224
 225         void kickAllPlayers(AccessDeniedCode reason,
 226                 const std::string &str_reason, bool reconnect);
 227         // Save players
 228         void saveLoadedPlayers();
 229         void savePlayer(RemotePlayer *player);
 230         Player *loadPlayer(const std::string &playername);
 231
 232         /*
 233                 Save and load time of day and game timer
 234         */
 235         void saveMeta();
 236         void loadMeta();
 237
 238         /*
 239                 External ActiveObject interface
 240                 -------------------------------------------
 241         */
 242
 243         ServerActiveObject* getActiveObject(u16 id);
 244
 245         /*
 246                 Add an active object to the environment.
 247                 Environment handles deletion of object.
 248                 Object may be deleted by environment immediately.
 249                 If id of object is 0, assigns a free id to it.
 250                 Returns the id of the object.
 251                 Returns 0 if not added and thus deleted.
 252         */
 253         u16 addActiveObject(ServerActiveObject *object);
 254
 255         /*
 256                 Add an active object as a static object to the corresponding
 257                 MapBlock.
 258                 Caller allocates memory, ServerEnvironment frees memory.
 259                 Return value: true if succeeded, false if failed.
 260                 (note:  not used, pending removal from engine)
 261         */
 262         //bool addActiveObjectAsStatic(ServerActiveObject *object);
 263
 264         /*
 265                 Find out what new objects have been added to
 266                 inside a radius around a position
 267         */
 268         void getAddedActiveObjects(Player *player, s16 radius,
 269                         s16 player_radius,
 270                         std::set<u16> &current_objects,
 271                         std::queue<u16> &added_objects);
 272
 273         /*
 274                 Find out what new objects have been removed from
 275                 inside a radius around a position
 276         */
 277         void getRemovedActiveObjects(Player* player, s16 radius,
 278                         s16 player_radius,
 279                         std::set<u16> &current_objects,
 280                         std::queue<u16> &removed_objects);
 281
 282         /*
 283                 Get the next message emitted by some active object.
 284                 Returns a message with id=0 if no messages are available.
 285         */
 286         ActiveObjectMessage getActiveObjectMessage();
 287
 288         /*
 289                 Activate objects and dynamically modify for the dtime determined
 290                 from timestamp and additional_dtime
 291         */
 292         void activateBlock(MapBlock *block, u32 additional_dtime=0);
 293
 294         /*
 295                 ActiveBlockModifiers
 296                 -------------------------------------------
 297         */
 298
 299         void addActiveBlockModifier(ActiveBlockModifier *abm);
 300
 301         /*
 302                 Other stuff
 303                 -------------------------------------------
 304         */
 305
 306         // Script-aware node setters
 307         bool setNode(v3s16 p, const MapNode &n);
 308         bool removeNode(v3s16 p);
 309         bool swapNode(v3s16 p, const MapNode &n);
 310
 311         // Find all active objects inside a radius around a point
 312         void getObjectsInsideRadius(std::vector<u16> &objects, v3f pos, float radius);
 313
 314         // Clear all objects, loading and going through every MapBlock
 315         void clearAllObjects();
 316
 317         // This makes stuff happen
 318         void step(f32 dtime);
 319
 320         //check if there's a line of sight between two positions
 321         bool line_of_sight(v3f pos1, v3f pos2, float stepsize=1.0, v3s16 *p=NULL);
 322
 323         u32 getGameTime() { return m_game_time; }
 324
 325         void reportMaxLagEstimate(float f) { m_max_lag_estimate = f; }
 326         float getMaxLagEstimate() { return m_max_lag_estimate; }
 327
 328         std::set<v3s16>* getForceloadedBlocks() { return &m_active_blocks.m_forceloaded_list; };
 329
 330         // Sets the static object status all the active objects in the specified block
 331         // This is only really needed for deleting blocks from the map
 332         void setStaticForActiveObjectsInBlock(v3s16 blockpos,
 333                 bool static_exists, v3s16 static_block=v3s16(0,0,0));
 334
 335 private:
 336
 337         /*
 338                 Internal ActiveObject interface
 339                 -------------------------------------------
 340         */
 341
 342         /*
 343                 Add an active object to the environment.
 344
 345                 Called by addActiveObject.
 346
 347                 Object may be deleted by environment immediately.
 348                 If id of object is 0, assigns a free id to it.
 349                 Returns the id of the object.
 350                 Returns 0 if not added and thus deleted.
 351         */
 352         u16 addActiveObjectRaw(ServerActiveObject *object, bool set_changed, u32 dtime_s);
 353
 354         /*
 355                 Remove all objects that satisfy (m_removed && m_known_by_count==0)
 356         */
 357         void removeRemovedObjects();
 358
 359         /*
 360                 Convert stored objects from block to active
 361         */
 362         void activateObjects(MapBlock *block, u32 dtime_s);
 363
 364         /*
 365                 Convert objects that are not in active blocks to static.
 366
 367                 If m_known_by_count != 0, active object is not deleted, but static
 368                 data is still updated.
 369
 370                 If force_delete is set, active object is deleted nevertheless. It
 371                 shall only be set so in the destructor of the environment.
 372         */
 373         void deactivateFarObjects(bool force_delete);
 374
 375         /*
 376                 Member variables
 377         */
 378
 379         // The map
 380         ServerMap *m_map;
 381         // Lua state
 382         GameScripting* m_script;
 383         // Game definition
 384         IGameDef *m_gamedef;
 385         // World path
 386         const std::string m_path_world;
 387         // Active object list
 388         std::map<u16, ServerActiveObject*> m_active_objects;
 389         // Outgoing network message buffer for active objects
 390         std::queue<ActiveObjectMessage> m_active_object_messages;
 391         // Some timers
 392         float m_send_recommended_timer;
 393         IntervalLimiter m_object_management_interval;
 394         // List of active blocks
 395         ActiveBlockList m_active_blocks;
 396         IntervalLimiter m_active_blocks_management_interval;
 397         IntervalLimiter m_active_block_modifier_interval;
 398         IntervalLimiter m_active_blocks_nodemetadata_interval;
 399         int m_active_block_interval_overload_skip;
 400         // Time from the beginning of the game in seconds.
 401         // Incremented in step().
 402         u32 m_game_time;
 403         // A helper variable for incrementing the latter
 404         float m_game_time_fraction_counter;
 405         std::vector<ABMWithState> m_abms;
 406         // An interval for generally sending object positions and stuff
 407         float m_recommended_send_interval;
 408         // Estimate for general maximum lag as determined by server.
 409         // Can raise to high values like 15s with eg. map generation mods.
 410         float m_max_lag_estimate;
 411 };
 412
 413 #ifndef SERVER
 414
 415 #include "clientobject.h"
 416 #include "content_cao.h"
 417
 418 class ClientSimpleObject;
 419
 420 /*
 421         The client-side environment.
 422
 423         This is not thread-safe.
 424         Must be called from main (irrlicht) thread (uses the SceneManager)
 425         Client uses an environment mutex.
 426 */
 427
 428 enum ClientEnvEventType
 429 {
 430         CEE_NONE,
 431         CEE_PLAYER_DAMAGE,
 432         CEE_PLAYER_BREATH
 433 };
 434
 435 struct ClientEnvEvent
 436 {
 437         ClientEnvEventType type;
 438         union {
 439                 //struct{
 440                 //} none;
 441                 struct{
 442                         u8 amount;
 443                         bool send_to_server;
 444                 } player_damage;
 445                 struct{
 446                         u16 amount;
 447                 } player_breath;
 448         };
 449 };
 450
 451 class ClientEnvironment : public Environment
 452 {
 453 public:
 454         ClientEnvironment(ClientMap *map, scene::ISceneManager *smgr,
 455                         ITextureSource *texturesource, IGameDef *gamedef,
 456                         IrrlichtDevice *device);
 457         ~ClientEnvironment();
 458
 459         Map & getMap();
 460         ClientMap & getClientMap();
 461
 462         IGameDef *getGameDef()
 463         { return m_gamedef; }
 464
 465         void step(f32 dtime);
 466
 467         virtual void addPlayer(Player *player);
 468         LocalPlayer * getLocalPlayer();
 469
 470         /*
 471                 ClientSimpleObjects
 472         */
 473
 474         void addSimpleObject(ClientSimpleObject *simple);
 475
 476         /*
 477                 ActiveObjects
 478         */
 479
 480         GenericCAO* getGenericCAO(u16 id);
 481         ClientActiveObject* getActiveObject(u16 id);
 482
 483         /*
 484                 Adds an active object to the environment.
 485                 Environment handles deletion of object.
 486                 Object may be deleted by environment immediately.
 487                 If id of object is 0, assigns a free id to it.
 488                 Returns the id of the object.
 489                 Returns 0 if not added and thus deleted.
 490         */
 491         u16 addActiveObject(ClientActiveObject *object);
 492
 493         void addActiveObject(u16 id, u8 type, const std::string &init_data);
 494         void removeActiveObject(u16 id);
 495
 496         void processActiveObjectMessage(u16 id, const std::string &data);
 497
 498         /*
 499                 Callbacks for activeobjects
 500         */
 501
 502         void damageLocalPlayer(u8 damage, bool handle_hp=true);
 503         void updateLocalPlayerBreath(u16 breath);
 504
 505         /*
 506                 Client likes to call these
 507         */
 508
 509         // Get all nearby objects
 510         void getActiveObjects(v3f origin, f32 max_d,
 511                         std::vector<DistanceSortedActiveObject> &dest);
 512
 513         // Get event from queue. CEE_NONE is returned if queue is empty.
 514         ClientEnvEvent getClientEvent();
 515
 516         u16 attachement_parent_ids[USHRT_MAX + 1];
 517
 518         std::list<std::string> getPlayerNames()
 519         { return m_player_names; }
 520         void addPlayerName(std::string name)
 521         { m_player_names.push_back(name); }
 522         void removePlayerName(std::string name)
 523         { m_player_names.remove(name); }
 524         void updateCameraOffset(v3s16 camera_offset)
 525         { m_camera_offset = camera_offset; }
 526         v3s16 getCameraOffset()
 527         { return m_camera_offset; }
 528
 529 private:
 530         ClientMap *m_map;
 531         scene::ISceneManager *m_smgr;
 532         ITextureSource *m_texturesource;
 533         IGameDef *m_gamedef;
 534         IrrlichtDevice *m_irr;
 535         std::map<u16, ClientActiveObject*> m_active_objects;
 536         std::vector<ClientSimpleObject*> m_simple_objects;
 537         std::queue<ClientEnvEvent> m_client_event_queue;
 538         IntervalLimiter m_active_object_light_update_interval;
 539         IntervalLimiter m_lava_hurt_interval;
 540         IntervalLimiter m_drowning_interval;
 541         IntervalLimiter m_breathing_interval;
 542         std::list<std::string> m_player_names;
 543         v3s16 m_camera_offset;
 544 };
 545
 546 #endif
 547
 548 #endif
 549