Properly and efficiently use split utility headers
[oweals/minetest.git] / src / environment.h
index b4f2a64caeb465ee5614b5a89452b44f17a3fe26..710b62ee0e62058892c1d7449cce462290ec4f9d 100644 (file)
@@ -3,16 +3,16 @@ Minetest-c55
 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
 (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License along
+You should have received a copy of the GNU Lesser General Public License along
 with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
@@ -26,16 +26,27 @@ with this program; if not, write to the Free Software Foundation, Inc.,
        - The map
        - Players
        - Other objects
-       - The current time in the game (actually it only contains the brightness)
+       - The current time in the game
        - etc.
 */
 
-#include <list>
+#include <set>
 #include "common_irrlicht.h"
 #include "player.h"
 #include "map.h"
 #include <ostream>
-#include "utility.h"
+#include "activeobject.h"
+#include "util/container.h"
+#include "util/numeric.h"
+
+class Server;
+class ServerEnvironment;
+class ActiveBlockModifier;
+class ServerActiveObject;
+typedef struct lua_State lua_State;
+class ITextureSource;
+class IGameDef;
+class ClientMap;
 
 class Environment
 {
@@ -64,27 +75,76 @@ public:
        core::list<Player*> getPlayers(bool ignore_disconnected);
        void printPlayers(std::ostream &o);
        
-       //void setDayNightRatio(u32 r);
        u32 getDayNightRatio();
        
        // 0-23999
        virtual void setTimeOfDay(u32 time)
        {
                m_time_of_day = time;
+               m_time_of_day_f = (float)time / 24000.0;
        }
 
        u32 getTimeOfDay()
-       {
-               return m_time_of_day;
-       }
+       { return m_time_of_day; }
+
+       float getTimeOfDayF()
+       { return m_time_of_day_f; }
+
+       void stepTimeOfDay(float dtime);
+
+       void setTimeOfDaySpeed(float speed)
+       { m_time_of_day_speed = speed; }
+       
+       float getTimeOfDaySpeed()
+       { return m_time_of_day_speed; }
 
 protected:
        // peer_ids in here should be unique, except that there may be many 0s
        core::list<Player*> m_players;
-       // Brightness
-       //u32 m_daynight_ratio;
        // Time of day in milli-hours (0-23999); determines day and night
        u32 m_time_of_day;
+       // Time of day in 0...1
+       float m_time_of_day_f;
+       float m_time_of_day_speed;
+       // Used to buffer dtime for adding to m_time_of_day
+       float m_time_counter;
+};
+
+/*
+       Active block modifier interface.
+
+       These are fed into ServerEnvironment at initialization time;
+       ServerEnvironment handles deleting them.
+*/
+
+class ActiveBlockModifier
+{
+public:
+       ActiveBlockModifier(){};
+       virtual ~ActiveBlockModifier(){};
+       
+       // Set of contents to trigger on
+       virtual std::set<std::string> getTriggerContents()=0;
+       // Set of required neighbors (trigger doesn't happen if none are found)
+       // Empty = do not check neighbors
+       virtual std::set<std::string> getRequiredNeighbors()
+       { return std::set<std::string>(); }
+       // Trigger interval in seconds
+       virtual float getTriggerInterval() = 0;
+       // Random chance of (1 / return value), 0 is disallowed
+       virtual u32 getTriggerChance() = 0;
+       // This is called usually at interval for 1/chance of the nodes
+       virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n){};
+       virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
+                       u32 active_object_count, u32 active_object_count_wider){};
+};
+
+struct ABMWithState
+{
+       ActiveBlockModifier *abm;
+       float timer;
+
+       ABMWithState(ActiveBlockModifier *abm_);
 };
 
 /*
@@ -112,40 +172,42 @@ public:
 private:
 };
 
+class IBackgroundBlockEmerger
+{
+public:
+       virtual void queueBlockEmerge(v3s16 blockpos, bool allow_generate)=0;
+};
+
 /*
        The server-side environment.
 
        This is not thread-safe. Server uses an environment mutex.
 */
 
-#include "serverobject.h"
-
-class Server;
-class ActiveBlockModifier;
-
 class ServerEnvironment : public Environment
 {
 public:
-       ServerEnvironment(ServerMap *map, Server *server);
+       ServerEnvironment(ServerMap *map, lua_State *L, IGameDef *gamedef,
+                       IBackgroundBlockEmerger *emerger);
        ~ServerEnvironment();
 
        Map & getMap()
-       {
-               return *m_map;
-       }
+               { return *m_map; }
 
        ServerMap & getServerMap()
-       {
-               return *m_map;
-       }
+               { return *m_map; }
+
+       lua_State* getLua()
+               { return m_lua; }
+
+       IGameDef *getGameDef()
+               { return m_gamedef; }
 
-       Server * getServer()
+       float getSendRecommendedInterval()
        {
-               return m_server;
+               return 0.10;
        }
 
-       void step(f32 dtime);
-       
        /*
                Save players
        */
@@ -159,7 +221,7 @@ public:
        void loadMeta(const std::string &savedir);
 
        /*
-               ActiveObjects
+               External ActiveObject interface
                -------------------------------------------
        */
 
@@ -175,6 +237,14 @@ public:
        */
        u16 addActiveObject(ServerActiveObject *object);
        
+       /*
+               Add an active object as a static object to the corresponding
+               MapBlock.
+               Caller allocates memory, ServerEnvironment frees memory.
+               Return value: true if succeeded, false if failed.
+       */
+       bool addActiveObjectAsStatic(ServerActiveObject *object);
+       
        /*
                Find out what new objects have been added to
                inside a radius around a position
@@ -197,6 +267,12 @@ public:
        */
        ActiveObjectMessage getActiveObjectMessage();
 
+       /*
+               Activate objects and dynamically modify for the dtime determined
+               from timestamp and additional_dtime
+       */
+       void activateBlock(MapBlock *block, u32 additional_dtime=0);
+
        /*
                ActiveBlockModifiers
                -------------------------------------------
@@ -204,7 +280,39 @@ public:
 
        void addActiveBlockModifier(ActiveBlockModifier *abm);
 
+       /*
+               Other stuff
+               -------------------------------------------
+       */
+       
+       // Find all active objects inside a radius around a point
+       std::set<u16> getObjectsInsideRadius(v3f pos, float radius);
+       
+       // Clear all objects, loading and going through every MapBlock
+       void clearAllObjects();
+       
+       // This makes stuff happen
+       void step(f32 dtime);
+       
 private:
+
+       /*
+               Internal ActiveObject interface
+               -------------------------------------------
+       */
+
+       /*
+               Add an active object to the environment.
+
+               Called by addActiveObject.
+
+               Object may be deleted by environment immediately.
+               If id of object is 0, assigns a free id to it.
+               Returns the id of the object.
+               Returns 0 if not added and thus deleted.
+       */
+       u16 addActiveObjectRaw(ServerActiveObject *object, bool set_changed);
+       
        /*
                Remove all objects that satisfy (m_removed && m_known_by_count==0)
        */
@@ -232,8 +340,12 @@ private:
        
        // The map
        ServerMap *m_map;
-       // Pointer to server (which is handling this environment)
-       Server *m_server;
+       // Lua state
+       lua_State *m_lua;
+       // Game definition
+       IGameDef *m_gamedef;
+       // Background block emerger (the server, in practice)
+       IBackgroundBlockEmerger *m_emerger;
        // Active object list
        core::map<u16, ServerActiveObject*> m_active_objects;
        // Outgoing network message buffer for active objects
@@ -245,41 +357,20 @@ private:
        // List of active blocks
        ActiveBlockList m_active_blocks;
        IntervalLimiter m_active_blocks_management_interval;
-       IntervalLimiter m_active_blocks_test_interval;
+       IntervalLimiter m_active_block_modifier_interval;
        IntervalLimiter m_active_blocks_nodemetadata_interval;
        // Time from the beginning of the game in seconds.
        // Incremented in step().
        u32 m_game_time;
        // A helper variable for incrementing the latter
        float m_game_time_fraction_counter;
-};
-
-/*
-       Active block modifier interface.
-
-       These are fed into ServerEnvironment at initialization time;
-       ServerEnvironment handles deleting them.
-*/
-
-class ActiveBlockModifier
-{
-public:
-       ActiveBlockModifier(){};
-       virtual ~ActiveBlockModifier(){};
-
-       //virtual core::list<u8> update(ServerEnvironment *env) = 0;
-       virtual u32 getTriggerContentCount(){ return 1;}
-       virtual u8 getTriggerContent(u32 i) = 0;
-       virtual float getActiveInterval() = 0;
-       // chance of (1 / return value), 0 is disallowed
-       virtual u32 getActiveChance() = 0;
-       // This is called usually at interval for 1/chance of the nodes
-       virtual void triggerEvent(ServerEnvironment *env, v3s16 p) = 0;
+       core::list<ABMWithState> m_abms;
 };
 
 #ifndef SERVER
 
 #include "clientobject.h"
+class ClientSimpleObject;
 
 /*
        The client-side environment.
@@ -303,6 +394,7 @@ struct ClientEnvEvent
                } none;
                struct{
                        u8 amount;
+                       bool send_to_server;
                } player_damage;
        };
 };
@@ -310,40 +402,27 @@ struct ClientEnvEvent
 class ClientEnvironment : public Environment
 {
 public:
-       ClientEnvironment(ClientMap *map, scene::ISceneManager *smgr);
+       ClientEnvironment(ClientMap *map, scene::ISceneManager *smgr,
+                       ITextureSource *texturesource, IGameDef *gamedef,
+                       IrrlichtDevice *device);
        ~ClientEnvironment();
 
-       Map & getMap()
-       {
-               return *m_map;
-       }
+       Map & getMap();
+       ClientMap & getClientMap();
 
-       ClientMap & getClientMap()
-       {
-               return *m_map;
-       }
+       IGameDef *getGameDef()
+       { return m_gamedef; }
 
        void step(f32 dtime);
 
        virtual void addPlayer(Player *player);
        LocalPlayer * getLocalPlayer();
+       
+       /*
+               ClientSimpleObjects
+       */
 
-       void updateMeshes(v3s16 blockpos);
-       void expireMeshes(bool only_daynight_diffed);
-
-       void setTimeOfDay(u32 time)
-       {
-               u32 old_dr = getDayNightRatio();
-
-               Environment::setTimeOfDay(time);
-
-               if(getDayNightRatio() != old_dr)
-               {
-                       dout_client<<DTIME<<"ClientEnvironment: DayNightRatio changed"
-                                       <<" -> expiring meshes"<<std::endl;
-                       expireMeshes(true);
-               }
-       }
+       void addSimpleObject(ClientSimpleObject *simple);
 
        /*
                ActiveObjects
@@ -370,7 +449,7 @@ public:
                Callbacks for activeobjects
        */
 
-       void damageLocalPlayer(u8 damage);
+       void damageLocalPlayer(u8 damage, bool handle_hp=true);
 
        /*
                Client likes to call these
@@ -386,8 +465,14 @@ public:
 private:
        ClientMap *m_map;
        scene::ISceneManager *m_smgr;
+       ITextureSource *m_texturesource;
+       IGameDef *m_gamedef;
+       IrrlichtDevice *m_irr;
        core::map<u16, ClientActiveObject*> m_active_objects;
+       core::list<ClientSimpleObject*> m_simple_objects;
        Queue<ClientEnvEvent> m_client_event_queue;
+       IntervalLimiter m_active_object_light_update_interval;
+       IntervalLimiter m_lava_hurt_interval;
 };
 
 #endif