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 #pragma once
  21
  22 /*
  23         This class is the game's environment.
  24         It contains:
  25         - The map
  26         - Players
  27         - Other objects
  28         - The current time in the game
  29         - etc.
  30 */
  31
  32 #include <list>
  33 #include <queue>
  34 #include <map>
  35 #include <atomic>
  36 #include <mutex>
  37 #include "irr_v3d.h"
  38 #include "network/networkprotocol.h" // for AccessDeniedCode
  39 #include "util/basic_macros.h"
  40
  41 class IGameDef;
  42 class Map;
  43 struct PointedThing;
  44 class RaycastState;
  45
  46 class Environment
  47 {
  48 public:
  49         // Environment will delete the map passed to the constructor
  50         Environment(IGameDef *gamedef);
  51         virtual ~Environment() = default;
  52         DISABLE_CLASS_COPY(Environment);
  53
  54         /*
  55                 Step everything in environment.
  56                 - Move players
  57                 - Step mobs
  58                 - Run timers of map
  59         */
  60         virtual void step(f32 dtime) = 0;
  61
  62         virtual Map &getMap() = 0;
  63
  64         u32 getDayNightRatio();
  65
  66         // 0-23999
  67         virtual void setTimeOfDay(u32 time);
  68         u32 getTimeOfDay();
  69         float getTimeOfDayF();
  70
  71         void stepTimeOfDay(float dtime);
  72
  73         void setTimeOfDaySpeed(float speed);
  74
  75         void setDayNightRatioOverride(bool enable, u32 value);
  76
  77         u32 getDayCount();
  78
  79         /*!
  80          * Gets the objects pointed by the shootline as
  81          * pointed things.
  82          * If this is a client environment, the local player
  83          * won't be returned.
  84          * @param[in]  shootline_on_map the shootline for
  85          * the test in world coordinates
  86          *
  87          * @param[out] objects          found objects
  88          */
  89         virtual void getSelectedActiveObjects(const core::line3d<f32> &shootline_on_map,
  90                         std::vector<PointedThing> &objects) = 0;
  91
  92         /*!
  93          * Returns the next node or object the shootline meets.
  94          * @param state current state of the raycast
  95          * @result output, will contain the next pointed thing
  96          */
  97         void continueRaycast(RaycastState *state, PointedThing *result);
  98
  99         // counter used internally when triggering ABMs
 100         u32 m_added_objects;
 101
 102         IGameDef *getGameDef() { return m_gamedef; }
 103
 104 protected:
 105         std::atomic<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 = 0.0f;
 117         // Overriding the day-night ratio is useful for custom sky visuals
 118         bool m_enable_day_night_ratio_override = false;
 119         u32 m_day_night_ratio_override = 0.0f;
 120         // Days from the server start, accounts for time shift
 121         // in game (e.g. /time or bed usage)
 122         std::atomic<u32> m_day_count;
 123         /*
 124          * Above: values managed by m_time_lock
 125          */
 126
 127         /* TODO: Add a callback function so these can be updated when a setting
 128          *       changes.  At this point in time it doesn't matter (e.g. /set
 129          *       is documented to change server settings only)
 130          *
 131          * TODO: Local caching of settings is not optimal and should at some stage
 132          *       be updated to use a global settings object for getting thse values
 133          *       (as opposed to the this local caching). This can be addressed in
 134          *       a later release.
 135          */
 136         bool m_cache_enable_shaders;
 137         float m_cache_active_block_mgmt_interval;
 138         float m_cache_abm_interval;
 139         float m_cache_ao_interval;
 140         float m_cache_nodetimer_interval;
 141
 142         IGameDef *m_gamedef;
 143
 144 private:
 145         std::mutex m_time_lock;
 146 };