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