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