Update inventory texture too
[oweals/minetest.git] / src / mapblock.h
index ce56825683b3255ee2e5b5f73e7c0e34562fe46a..e7fd932b8e2395e7613a53a8f91bdc98fd69fefd 100644 (file)
@@ -29,13 +29,20 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "exceptions.h"
 #include "serialization.h"
 #include "constants.h"
-#include "mapblockobject.h"
 #include "voxel.h"
-#include "nodemetadata.h"
 #include "staticobject.h"
+#include "mapblock_nodemod.h"
+#ifndef SERVER
+       #include "mapblock_mesh.h"
+#endif
+
+class Map;
+class NodeMetadataList;
+class IGameDef;
 
+#define BLOCK_TIMESTAMP_UNDEFINED 0xffffffff
 
-// Named by looking towards z+
+/*// Named by looking towards z+
 enum{
        FACE_BACK=0,
        FACE_TOP,
@@ -43,104 +50,39 @@ enum{
        FACE_FRONT,
        FACE_BOTTOM,
        FACE_LEFT
-};
-
-struct FastFace
-{
-       TileSpec tile;
-       video::S3DVertex vertices[4]; // Precalculated vertices
-};
+};*/
 
-enum NodeModType
+enum ModifiedState
 {
-       NODEMOD_NONE,
-       NODEMOD_CHANGECONTENT, //param is content id
-       NODEMOD_CRACK // param is crack progression
+       // Has not been modified.
+       MOD_STATE_CLEAN = 0,
+       MOD_RESERVED1 = 1,
+       // Has been modified, and will be saved when being unloaded.
+       MOD_STATE_WRITE_AT_UNLOAD = 2,
+       MOD_RESERVED3 = 3,
+       // Has been modified, and will be saved as soon as possible.
+       MOD_STATE_WRITE_NEEDED = 4,
+       MOD_RESERVED5 = 5,
 };
 
-struct NodeMod
+// NOTE: If this is enabled, set MapBlock to be initialized with
+//       CONTENT_IGNORE.
+/*enum BlockGenerationStatus
 {
-       NodeMod(enum NodeModType a_type=NODEMOD_NONE, u16 a_param=0)
-       {
-               type = a_type;
-               param = a_param;
-       }
-       bool operator==(const NodeMod &other)
-       {
-               return (type == other.type && param == other.param);
-       }
-       enum NodeModType type;
-       u16 param;
-};
-
-class NodeModMap
-{
-public:
-       /*
-               returns true if the mod was different last time
-       */
-       bool set(v3s16 p, const NodeMod &mod)
-       {
-               // See if old is different, cancel if it is not different.
-               core::map<v3s16, NodeMod>::Node *n = m_mods.find(p);
-               if(n)
-               {
-                       NodeMod old = n->getValue();
-                       if(old == mod)
-                               return false;
-
-                       n->setValue(mod);
-               }
-               else
-               {
-                       m_mods.insert(p, mod);
-               }
-               
-               return true;
-       }
-       // Returns true if there was one
-       bool get(v3s16 p, NodeMod *mod)
-       {
-               core::map<v3s16, NodeMod>::Node *n;
-               n = m_mods.find(p);
-               if(n == NULL)
-                       return false;
-               if(mod)
-                       *mod = n->getValue();
-               return true;
-       }
-       bool clear(v3s16 p)
-       {
-               if(m_mods.find(p))
-               {
-                       m_mods.remove(p);
-                       return true;
-               }
-               return false;
-       }
-       bool clear()
-       {
-               if(m_mods.size() == 0)
-                       return false;
-               m_mods.clear();
-               return true;
-       }
-       void copy(NodeModMap &dest)
-       {
-               dest.m_mods.clear();
-
-               for(core::map<v3s16, NodeMod>::Iterator
-                               i = m_mods.getIterator();
-                               i.atEnd() == false; i++)
-               {
-                       dest.m_mods.insert(i.getNode()->getKey(), i.getNode()->getValue());
-               }
-       }
-
-private:
-       core::map<v3s16, NodeMod> m_mods;
-};
-
+       // Completely non-generated (filled with CONTENT_IGNORE).
+       BLOCKGEN_UNTOUCHED=0,
+       // Trees or similar might have been blitted from other blocks to here.
+       // Otherwise, the block contains CONTENT_IGNORE
+       BLOCKGEN_FROM_NEIGHBORS=2,
+       // Has been generated, but some neighbors might put some stuff in here
+       // when they are generated.
+       // Does not contain any CONTENT_IGNORE
+       BLOCKGEN_SELF_GENERATED=4,
+       // The block and all its neighbors have been generated
+       BLOCKGEN_FULLY_GENERATED=6
+};*/
+
+#if 0
 enum
 {
        NODECONTAINER_ID_MAPBLOCK,
@@ -168,52 +110,24 @@ public:
                }
        }
 };
-
-/*
-       Mesh making stuff
-*/
-
-class MapBlock;
-
-#ifndef SERVER
-
-struct MeshMakeData
-{
-       u32 m_daynight_ratio;
-       NodeModMap m_temp_mods;
-       VoxelManipulator m_vmanip;
-       v3s16 m_blockpos;
-       
-       /*
-               Copy central data directly from block, and other data from
-               parent of block.
-       */
-       void fill(u32 daynight_ratio, MapBlock *block);
-};
-
-scene::SMesh* makeMapBlockMesh(MeshMakeData *data);
-
 #endif
 
-u8 getFaceLight(u32 daynight_ratio, MapNode n, MapNode n2,
-               v3s16 face_dir);
-
 /*
        MapBlock itself
 */
 
-class MapBlock : public NodeContainer
+class MapBlock /*: public NodeContainer*/
 {
 public:
-       MapBlock(NodeContainer *parent, v3s16 pos, bool dummy=false);
+       MapBlock(Map *parent, v3s16 pos, IGameDef *gamedef, bool dummy=false);
        ~MapBlock();
        
-       virtual u16 nodeContainerId() const
+       /*virtual u16 nodeContainerId() const
        {
                return NODECONTAINER_ID_MAPBLOCK;
-       }
+       }*/
        
-       NodeContainer * getParent()
+       Map * getParent()
        {
                return m_parent;
        }
@@ -225,9 +139,10 @@ public:
                u32 l = MAP_BLOCKSIZE * MAP_BLOCKSIZE * MAP_BLOCKSIZE;
                data = new MapNode[l];
                for(u32 i=0; i<l; i++){
-                       data[i] = MapNode();
+                       //data[i] = MapNode();
+                       data[i] = MapNode(CONTENT_IGNORE);
                }
-               setChangedFlag();
+               raiseModified(MOD_STATE_WRITE_NEEDED);
        }
 
        /*
@@ -244,28 +159,56 @@ public:
                reallocate();
        }
        
-       bool getChangedFlag()
+       /*
+               This is called internally or externally after the block is
+               modified, so that the block is saved and possibly not deleted from
+               memory.
+       */
+       // DEPRECATED, use *Modified()
+       void setChangedFlag()
        {
-               return changed;
+               //dstream<<"Deprecated setChangedFlag() called"<<std::endl;
+               raiseModified(MOD_STATE_WRITE_NEEDED);
        }
+       // DEPRECATED, use *Modified()
        void resetChangedFlag()
        {
-               changed = false;
+               //dstream<<"Deprecated resetChangedFlag() called"<<std::endl;
+               resetModified();
        }
-       void setChangedFlag()
+       // DEPRECATED, use *Modified()
+       bool getChangedFlag()
        {
-               changed = true;
+               //dstream<<"Deprecated getChangedFlag() called"<<std::endl;
+               if(getModified() == MOD_STATE_CLEAN)
+                       return false;
+               else
+                       return true;
        }
-
+       
+       // m_modified methods
+       void raiseModified(u32 mod)
+       {
+               m_modified = MYMAX(m_modified, mod);
+       }
+       u32 getModified()
+       {
+               return m_modified;
+       }
+       void resetModified()
+       {
+               m_modified = MOD_STATE_CLEAN;
+       }
+       
+       // is_underground getter/setter
        bool getIsUnderground()
        {
                return is_underground;
        }
-
        void setIsUnderground(bool a_is_underground)
        {
                is_underground = a_is_underground;
-               setChangedFlag();
+               raiseModified(MOD_STATE_WRITE_NEEDED);
        }
 
 #ifndef SERVER
@@ -282,23 +225,27 @@ public:
 
        void setLightingExpired(bool expired)
        {
-               m_lighting_expired = expired;
-               setChangedFlag();
+               if(expired != m_lighting_expired){
+                       m_lighting_expired = expired;
+                       raiseModified(MOD_STATE_WRITE_NEEDED);
+               }
        }
        bool getLightingExpired()
        {
                return m_lighting_expired;
        }
 
-       /*bool isFullyGenerated()
+       bool isGenerated()
        {
-               return !m_not_fully_generated;
+               return m_generated;
        }
-       void setFullyGenerated(bool b)
+       void setGenerated(bool b)
        {
-               setChangedFlag();
-               m_not_fully_generated = !b;
-       }*/
+               if(b != m_generated){
+                       raiseModified(MOD_STATE_WRITE_NEEDED);
+                       m_generated = b;
+               }
+       }
 
        bool isValid()
        {
@@ -359,6 +306,15 @@ public:
                return getNode(p.X, p.Y, p.Z);
        }
        
+       MapNode getNodeNoEx(v3s16 p)
+       {
+               try{
+                       return getNode(p.X, p.Y, p.Z);
+               }catch(InvalidPositionException &e){
+                       return MapNode(CONTENT_IGNORE);
+               }
+       }
+       
        void setNode(s16 x, s16 y, s16 z, MapNode & n)
        {
                if(data == NULL)
@@ -367,7 +323,7 @@ public:
                if(y < 0 || y >= MAP_BLOCKSIZE) throw InvalidPositionException();
                if(z < 0 || z >= MAP_BLOCKSIZE) throw InvalidPositionException();
                data[z*MAP_BLOCKSIZE*MAP_BLOCKSIZE + y*MAP_BLOCKSIZE + x] = n;
-               setChangedFlag();
+               raiseModified(MOD_STATE_WRITE_NEEDED);
        }
        
        void setNode(v3s16 p, MapNode & n)
@@ -396,7 +352,7 @@ public:
                if(data == NULL)
                        throw InvalidPositionException();
                data[z*MAP_BLOCKSIZE*MAP_BLOCKSIZE + y*MAP_BLOCKSIZE + x] = n;
-               setChangedFlag();
+               raiseModified(MOD_STATE_WRITE_NEEDED);
        }
        
        void setNodeNoCheck(v3s16 p, MapNode & n)
@@ -436,135 +392,39 @@ public:
                                getNodeParentNoEx(p + face_dir),
                                face_dir);
        }*/
-       u8 getFaceLight2(u32 daynight_ratio, v3s16 p, v3s16 face_dir)
+       u8 getFaceLight2(u32 daynight_ratio, v3s16 p, v3s16 face_dir,
+                       INodeDefManager *nodemgr)
        {
                return getFaceLight(daynight_ratio,
                                getNodeParentNoEx(p),
                                getNodeParentNoEx(p + face_dir),
-                               face_dir);
+                               face_dir, nodemgr);
        }
        
-#ifndef SERVER
-       // light = 0...255
-       /*static void makeFastFace(TileSpec tile, u8 light, v3f p,
-                       v3s16 dir, v3f scale, v3f posRelative_f,
-                       core::array<FastFace> &dest);*/
-       
-       /*TileSpec getNodeTile(MapNode mn, v3s16 p, v3s16 face_dir,
-                       NodeModMap &temp_mods);*/
-       /*u8 getNodeContent(v3s16 p, MapNode mn,
-                       NodeModMap &temp_mods);*/
-
-       /*
-               Generates the FastFaces of a node row. This has a
-               ridiculous amount of parameters because that way they
-               can be precalculated by the caller.
+#ifndef SERVER // Only on client
 
-               translate_dir: unit vector with only one of x, y or z
-               face_dir: unit vector with only one of x, y or z
-       */
-       /*void updateFastFaceRow(
-                       u32 daynight_ratio,
-                       v3f posRelative_f,
-                       v3s16 startpos,
-                       u16 length,
-                       v3s16 translate_dir,
-                       v3f translate_dir_f,
-                       v3s16 face_dir,
-                       v3f face_dir_f,
-                       core::array<FastFace> &dest,
-                       NodeModMap &temp_mods);*/
-       
+#if 1
        /*
                Thread-safely updates the whole mesh of the mapblock.
+               NOTE: Prefer generating the mesh separately and then using
+               replaceMesh().
        */
-#if 1
        void updateMesh(u32 daynight_ratio);
 #endif
-
+       // Replace the mesh with a new one
        void replaceMesh(scene::SMesh *mesh_new);
-       
-#endif // !SERVER
+#endif
        
        // See comments in mapblock.cpp
        bool propagateSunlight(core::map<v3s16, bool> & light_sources,
-                       bool remove_light=false, bool *black_air_left=NULL,
-                       bool grow_grass=false);
+                       bool remove_light=false, bool *black_air_left=NULL);
        
        // Copies data to VoxelManipulator to getPosRelative()
        void copyTo(VoxelManipulator &dst);
        // Copies data from VoxelManipulator getPosRelative()
        void copyFrom(VoxelManipulator &dst);
 
-       /*
-               MapBlockObject stuff
-       */
-       
-       void serializeObjects(std::ostream &os, u8 version)
-       {
-               m_objects.serialize(os, version);
-       }
-       // If smgr!=NULL, new objects are added to the scene
-       void updateObjects(std::istream &is, u8 version,
-                       scene::ISceneManager *smgr, u32 daynight_ratio)
-       {
-               m_objects.update(is, version, smgr, daynight_ratio);
-
-               setChangedFlag();
-       }
-       void clearObjects()
-       {
-               m_objects.clear();
-
-               setChangedFlag();
-       }
-       void addObject(MapBlockObject *object)
-                       throw(ContainerFullException, AlreadyExistsException)
-       {
-               m_objects.add(object);
-
-               setChangedFlag();
-       }
-       void removeObject(s16 id)
-       {
-               m_objects.remove(id);
-
-               setChangedFlag();
-       }
-       MapBlockObject * getObject(s16 id)
-       {
-               return m_objects.get(id);
-       }
-       JMutexAutoLock * getObjectLock()
-       {
-               return m_objects.getLock();
-       }
-
-       /*
-               Moves objects, deletes objects and spawns new objects
-       */
-       void stepObjects(float dtime, bool server, u32 daynight_ratio);
-
-       /*void wrapObject(MapBlockObject *object)
-       {
-               m_objects.wrapObject(object);
-
-               setChangedFlag();
-       }*/
-
-       // origin is relative to block
-       void getObjects(v3f origin, f32 max_d,
-                       core::array<DistanceSortedObject> &dest)
-       {
-               m_objects.getObjects(origin, max_d, dest);
-       }
-
-       s32 getObjectCount()
-       {
-               return m_objects.getCount();
-       }
-
-#ifndef SERVER
+#ifndef SERVER // Only on client
        /*
                Methods for setting temporary modifications to nodes for
                drawing
@@ -639,14 +499,50 @@ public:
        */
        s16 getGroundLevel(v2s16 p2d);
 
+       /*
+               Timestamp (see m_timestamp)
+               NOTE: BLOCK_TIMESTAMP_UNDEFINED=0xffffffff means there is no timestamp.
+       */
+       void setTimestamp(u32 time)
+       {
+               m_timestamp = time;
+               raiseModified(MOD_STATE_WRITE_AT_UNLOAD);
+       }
+       void setTimestampNoChangedFlag(u32 time)
+       {
+               m_timestamp = time;
+       }
+       u32 getTimestamp()
+       {
+               return m_timestamp;
+       }
+       
+       /*
+               See m_usage_timer
+       */
+       void resetUsageTimer()
+       {
+               m_usage_timer = 0;
+       }
+       void incrementUsageTimer(float dtime)
+       {
+               m_usage_timer += dtime;
+       }
+       u32 getUsageTimer()
+       {
+               return m_usage_timer;
+       }
+
        /*
                Serialization
        */
        
-       // Doesn't write version by itself
+       // These don't write or read version by itself
        void serialize(std::ostream &os, u8 version);
-
        void deSerialize(std::istream &is, u8 version);
+       // Used after the basic ones when writing on disk (serverside)
+       void serializeDiskExtra(std::ostream &os, u8 version);
+       void deSerializeDiskExtra(std::istream &is, u8 version);
 
 private:
        /*
@@ -676,12 +572,12 @@ public:
                Public member variables
        */
 
-#ifndef SERVER
+#ifndef SERVER // Only on client
        scene::SMesh *mesh;
        JMutex mesh_mutex;
 #endif
        
-       NodeMetadataList m_node_metadata;
+       NodeMetadataList *m_node_metadata;
        StaticObjectList m_static_objects;
        
 private:
@@ -690,9 +586,11 @@ private:
        */
 
        // NOTE: Lots of things rely on this being the Map
-       NodeContainer *m_parent;
+       Map *m_parent;
        // Position in blocks on parent
        v3s16 m_pos;
+
+       IGameDef *m_gamedef;
        
        /*
                If NULL, block is a dummy block.
@@ -702,10 +600,10 @@ private:
 
        /*
                - On the server, this is used for telling whether the
-                 block has been changed from the one on disk.
+                 block has been modified from the one on disk.
                - On the client, this is used for nothing.
        */
-       bool changed;
+       u32 m_modified;
 
        /*
                When propagating sunlight and the above block doesn't exist,
@@ -728,12 +626,9 @@ private:
        
        // Whether day and night lighting differs
        bool m_day_night_differs;
-       
-       MapBlockObjectList m_objects;
-
-       // Object spawning stuff
-       float m_spawn_timer;
 
+       bool m_generated;
+       
 #ifndef SERVER // Only on client
        /*
                Set to true if the mesh has been ordered to be updated
@@ -747,6 +642,18 @@ private:
        NodeModMap m_temp_mods;
        JMutex m_temp_mods_mutex;
 #endif
+       
+       /*
+               When block is removed from active blocks, this is set to gametime.
+               Value BLOCK_TIMESTAMP_UNDEFINED=0xffffffff means there is no timestamp.
+       */
+       u32 m_timestamp;
+
+       /*
+               When the block is accessed, this is set to 0.
+               Map will unload the block when this reaches a timeout.
+       */
+       float m_usage_timer;
 };
 
 inline bool blockpos_over_limit(v3s16 p)
@@ -778,5 +685,10 @@ inline s16 getNodeBlockY(s16 y)
        return getContainerPos(y, MAP_BLOCKSIZE);
 }
 
+/*
+       Get a quick string to describe what a block actually contains
+*/
+std::string analyze_block(MapBlock *block);
+
 #endif