3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
20 #ifndef ENVIRONMENT_HEADER
21 #define ENVIRONMENT_HEADER
24 This class is the game's environment.
29 - The current time in the game
37 #include "activeobject.h"
38 #include "util/numeric.h"
39 #include "threading/mutex.h"
40 #include "threading/atomic.h"
41 #include "network/networkprotocol.h" // for AccessDeniedCode
49 // Environment will delete the map passed to the constructor
50 Environment(IGameDef *gamedef);
51 virtual ~Environment();
54 Step everything in environment.
59 virtual void step(f32 dtime) = 0;
61 virtual Map &getMap() = 0;
63 u32 getDayNightRatio();
66 virtual void setTimeOfDay(u32 time);
68 float getTimeOfDayF();
70 void stepTimeOfDay(float dtime);
72 void setTimeOfDaySpeed(float speed);
74 void setDayNightRatioOverride(bool enable, u32 value);
78 // counter used internally when triggering ABMs
81 IGameDef *getGameDef() { return m_gamedef; }
83 GenericAtomic<float> m_time_of_day_speed;
86 * Below: values managed by m_time_lock
88 // Time of day in milli-hours (0-23999); determines day and night
90 // Time of day in 0...1
91 float m_time_of_day_f;
92 // Stores the skew created by the float -> u32 conversion
93 // to be applied at next conversion, so that there is no real skew.
94 float m_time_conversion_skew;
95 // Overriding the day-night ratio is useful for custom sky visuals
96 bool m_enable_day_night_ratio_override;
97 u32 m_day_night_ratio_override;
98 // Days from the server start, accounts for time shift
99 // in game (e.g. /time or bed usage)
100 Atomic<u32> m_day_count;
102 * Above: values managed by m_time_lock
105 /* TODO: Add a callback function so these can be updated when a setting
106 * changes. At this point in time it doesn't matter (e.g. /set
107 * is documented to change server settings only)
109 * TODO: Local caching of settings is not optimal and should at some stage
110 * be updated to use a global settings object for getting thse values
111 * (as opposed to the this local caching). This can be addressed in
114 bool m_cache_enable_shaders;
115 float m_cache_active_block_mgmt_interval;
116 float m_cache_abm_interval;
117 float m_cache_nodetimer_interval;
124 DISABLE_CLASS_COPY(Environment);