/*
-Minetest-c55
-Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
+Minetest
+Copyright (C) 2013 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.
*/
-#ifndef MAPBLOCK_HEADER
-#define MAPBLOCK_HEADER
+#pragma once
-#include <jmutex.h>
-#include <jmutexautolock.h>
-#include <exception>
-#include "debug.h"
-#include "common_irrlicht.h"
+#include <set>
+#include "irr_v3d.h"
#include "mapnode.h"
#include "exceptions.h"
-#include "serialization.h"
#include "constants.h"
-#include "mapblockobject.h"
-#include "voxel.h"
-
-// Named by looking towards z+
-enum{
- FACE_BACK=0,
- FACE_TOP,
- FACE_RIGHT,
- FACE_FRONT,
- FACE_BOTTOM,
- FACE_LEFT
-};
-
-struct FastFace
+#include "staticobject.h"
+#include "nodemetadata.h"
+#include "nodetimer.h"
+#include "modifiedstate.h"
+#include "util/numeric.h" // getContainerPos
+#include "settings.h"
+#include "mapgen/mapgen.h"
+
+class Map;
+class NodeMetadataList;
+class IGameDef;
+class MapBlockMesh;
+class VoxelManipulator;
+
+#define BLOCK_TIMESTAMP_UNDEFINED 0xffffffff
+
+////
+//// MapBlock modified reason flags
+////
+
+#define MOD_REASON_INITIAL (1 << 0)
+#define MOD_REASON_REALLOCATE (1 << 1)
+#define MOD_REASON_SET_IS_UNDERGROUND (1 << 2)
+#define MOD_REASON_SET_LIGHTING_COMPLETE (1 << 3)
+#define MOD_REASON_SET_GENERATED (1 << 4)
+#define MOD_REASON_SET_NODE (1 << 5)
+#define MOD_REASON_SET_NODE_NO_CHECK (1 << 6)
+#define MOD_REASON_SET_TIMESTAMP (1 << 7)
+#define MOD_REASON_REPORT_META_CHANGE (1 << 8)
+#define MOD_REASON_CLEAR_ALL_OBJECTS (1 << 9)
+#define MOD_REASON_BLOCK_EXPIRED (1 << 10)
+#define MOD_REASON_ADD_ACTIVE_OBJECT_RAW (1 << 11)
+#define MOD_REASON_REMOVE_OBJECTS_REMOVE (1 << 12)
+#define MOD_REASON_REMOVE_OBJECTS_DEACTIVATE (1 << 13)
+#define MOD_REASON_TOO_MANY_OBJECTS (1 << 14)
+#define MOD_REASON_STATIC_DATA_ADDED (1 << 15)
+#define MOD_REASON_STATIC_DATA_REMOVED (1 << 16)
+#define MOD_REASON_STATIC_DATA_CHANGED (1 << 17)
+#define MOD_REASON_EXPIRE_DAYNIGHTDIFF (1 << 18)
+#define MOD_REASON_VMANIP (1 << 19)
+#define MOD_REASON_UNKNOWN (1 << 20)
+
+////
+//// MapBlock itself
+////
+
+class MapBlock
{
- TileSpec tile;
- video::S3DVertex vertices[4]; // Precalculated vertices
-};
+public:
+ MapBlock(Map *parent, v3s16 pos, IGameDef *gamedef, bool dummy=false);
+ ~MapBlock();
-enum NodeModType
-{
- NODEMOD_NONE,
- NODEMOD_CHANGECONTENT, //param is content id
- NODEMOD_CRACK // param is crack progression
-};
+ /*virtual u16 nodeContainerId() const
+ {
+ return NODECONTAINER_ID_MAPBLOCK;
+ }*/
-struct NodeMod
-{
- NodeMod(enum NodeModType a_type=NODEMOD_NONE, u16 a_param=0)
+ Map * getParent()
{
- type = a_type;
- param = a_param;
+ return m_parent;
}
- bool operator==(const NodeMod &other)
+
+ void reallocate()
{
- return (type == other.type && param == other.param);
+ delete[] data;
+ data = new MapNode[nodecount];
+ for (u32 i = 0; i < nodecount; i++)
+ data[i] = MapNode(CONTENT_IGNORE);
+
+ raiseModified(MOD_STATE_WRITE_NEEDED, MOD_REASON_REALLOCATE);
}
- enum NodeModType type;
- u16 param;
-};
-enum
-{
- NODECONTAINER_ID_MAPBLOCK,
- NODECONTAINER_ID_MAPSECTOR,
- NODECONTAINER_ID_MAP,
- NODECONTAINER_ID_MAPBLOCKCACHE,
- NODECONTAINER_ID_VOXELMANIPULATOR,
-};
+ MapNode* getData()
+ {
+ return data;
+ }
-class NodeContainer
-{
-public:
- virtual bool isValidPosition(v3s16 p) = 0;
- virtual MapNode getNode(v3s16 p) = 0;
- virtual void setNode(v3s16 p, MapNode & n) = 0;
- virtual u16 nodeContainerId() const = 0;
-};
+ ////
+ //// Modification tracking methods
+ ////
+ void raiseModified(u32 mod, u32 reason=MOD_REASON_UNKNOWN)
+ {
+ if (mod > m_modified) {
+ m_modified = mod;
+ m_modified_reason = reason;
+ if (m_modified >= MOD_STATE_WRITE_AT_UNLOAD)
+ m_disk_timestamp = m_timestamp;
+ } else if (mod == m_modified) {
+ m_modified_reason |= reason;
+ }
+ if (mod == MOD_STATE_WRITE_NEEDED)
+ contents_cached = false;
+ }
-class MapBlock : public NodeContainer
-{
-public:
- MapBlock(NodeContainer *parent, v3s16 pos, bool dummy=false);
- ~MapBlock();
-
- virtual u16 nodeContainerId() const
+ inline u32 getModified()
{
- return NODECONTAINER_ID_MAPBLOCK;
+ return m_modified;
}
- NodeContainer * getParent()
+ inline u32 getModifiedReason()
{
- return m_parent;
+ return m_modified_reason;
}
- bool isDummy()
+ std::string getModifiedReasonString();
+
+ inline void resetModified()
{
- return (data == NULL);
+ m_modified = MOD_STATE_CLEAN;
+ m_modified_reason = 0;
}
- void unDummify()
+ ////
+ //// Flags
+ ////
+
+ inline bool isDummy()
{
- assert(isDummy());
+ return !data;
+ }
+
+ inline void unDummify()
+ {
+ assert(isDummy()); // Pre-condition
reallocate();
}
-
- bool getChangedFlag()
+
+ // is_underground getter/setter
+ inline bool getIsUnderground()
{
- return changed;
+ return is_underground;
}
- void resetChangedFlag()
+ inline void setIsUnderground(bool a_is_underground)
{
- changed = false;
+ is_underground = a_is_underground;
+ raiseModified(MOD_STATE_WRITE_NEEDED, MOD_REASON_SET_IS_UNDERGROUND);
}
- void setChangedFlag()
+ inline void setLightingComplete(u16 newflags)
{
- changed = true;
+ if (newflags != m_lighting_complete) {
+ m_lighting_complete = newflags;
+ raiseModified(MOD_STATE_WRITE_NEEDED, MOD_REASON_SET_LIGHTING_COMPLETE);
+ }
}
-#ifndef SERVER
- void setMeshExpired(bool expired)
+
+ inline u16 getLightingComplete()
{
- m_mesh_expired = expired;
+ return m_lighting_complete;
}
-
- bool getMeshExpired()
+
+ inline void setLightingComplete(LightBank bank, u8 direction,
+ bool is_complete)
{
- return m_mesh_expired;
+ assert(direction >= 0 && direction <= 5);
+ if (bank == LIGHTBANK_NIGHT) {
+ direction += 6;
+ }
+ u16 newflags = m_lighting_complete;
+ if (is_complete) {
+ newflags |= 1 << direction;
+ } else {
+ newflags &= ~(1 << direction);
+ }
+ setLightingComplete(newflags);
}
-#endif
- v3s16 getPos()
+
+ inline bool isLightingComplete(LightBank bank, u8 direction)
{
- return m_pos;
+ assert(direction >= 0 && direction <= 5);
+ if (bank == LIGHTBANK_NIGHT) {
+ direction += 6;
+ }
+ return (m_lighting_complete & (1 << direction)) != 0;
}
-
- v3s16 getPosRelative()
+
+ inline bool isGenerated()
{
- return m_pos * MAP_BLOCKSIZE;
+ return m_generated;
}
-
- bool getIsUnderground()
+
+ inline void setGenerated(bool b)
{
- return is_underground;
+ if (b != m_generated) {
+ raiseModified(MOD_STATE_WRITE_NEEDED, MOD_REASON_SET_GENERATED);
+ m_generated = b;
+ }
}
- void setIsUnderground(bool a_is_underground)
+ ////
+ //// Position stuff
+ ////
+
+ inline v3s16 getPos()
{
- is_underground = a_is_underground;
- setChangedFlag();
+ return m_pos;
}
- core::aabbox3d<s16> getBox()
+ inline v3s16 getPosRelative()
+ {
+ return m_pos_relative;
+ }
+
+ inline core::aabbox3d<s16> getBox()
{
return core::aabbox3d<s16>(getPosRelative(),
getPosRelative()
+ v3s16(MAP_BLOCKSIZE, MAP_BLOCKSIZE, MAP_BLOCKSIZE)
- v3s16(1,1,1));
}
-
- void reallocate()
+
+ ////
+ //// Regular MapNode get-setters
+ ////
+
+ inline bool isValidPosition(s16 x, s16 y, s16 z)
{
- if(data != NULL)
- delete[] data;
- u32 l = MAP_BLOCKSIZE * MAP_BLOCKSIZE * MAP_BLOCKSIZE;
- data = new MapNode[l];
- for(u32 i=0; i<l; i++){
- data[i] = MapNode();
- }
- setChangedFlag();
+ return data
+ && x >= 0 && x < MAP_BLOCKSIZE
+ && y >= 0 && y < MAP_BLOCKSIZE
+ && z >= 0 && z < MAP_BLOCKSIZE;
}
- bool isValidPosition(v3s16 p)
+ inline bool isValidPosition(v3s16 p)
{
- if(data == NULL)
- return false;
- return (p.X >= 0 && p.X < MAP_BLOCKSIZE
- && p.Y >= 0 && p.Y < MAP_BLOCKSIZE
- && p.Z >= 0 && p.Z < MAP_BLOCKSIZE);
+ return isValidPosition(p.X, p.Y, p.Z);
}
- /*
- Regular MapNode get-setters
- */
-
- MapNode getNode(s16 x, s16 y, s16 z)
+ inline MapNode getNode(s16 x, s16 y, s16 z, bool *valid_position)
{
- if(data == NULL)
- throw InvalidPositionException();
- if(x < 0 || x >= MAP_BLOCKSIZE) throw InvalidPositionException();
- if(y < 0 || y >= MAP_BLOCKSIZE) throw InvalidPositionException();
- if(z < 0 || z >= MAP_BLOCKSIZE) throw InvalidPositionException();
- return data[z*MAP_BLOCKSIZE*MAP_BLOCKSIZE + y*MAP_BLOCKSIZE + x];
+ *valid_position = isValidPosition(x, y, z);
+
+ if (!*valid_position)
+ return {CONTENT_IGNORE};
+
+ return data[z * zstride + y * ystride + x];
}
-
- MapNode getNode(v3s16 p)
+
+ inline MapNode getNode(v3s16 p, bool *valid_position)
{
- return getNode(p.X, p.Y, p.Z);
+ return getNode(p.X, p.Y, p.Z, valid_position);
}
-
- void setNode(s16 x, s16 y, s16 z, MapNode & n)
+
+ inline MapNode getNodeNoEx(v3s16 p)
{
- if(data == NULL)
+ bool is_valid;
+ return getNode(p.X, p.Y, p.Z, &is_valid);
+ }
+
+ inline void setNode(s16 x, s16 y, s16 z, MapNode & n)
+ {
+ if (!isValidPosition(x, y, z))
throw InvalidPositionException();
- if(x < 0 || x >= MAP_BLOCKSIZE) throw InvalidPositionException();
- 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();
+
+ data[z * zstride + y * ystride + x] = n;
+ raiseModified(MOD_STATE_WRITE_NEEDED, MOD_REASON_SET_NODE);
}
-
- void setNode(v3s16 p, MapNode & n)
+
+ inline void setNode(v3s16 p, MapNode & n)
{
setNode(p.X, p.Y, p.Z, n);
}
- /*
- Non-checking variants of the above
- */
+ ////
+ //// Non-checking variants of the above
+ ////
- MapNode getNodeNoCheck(s16 x, s16 y, s16 z)
+ inline MapNode getNodeNoCheck(s16 x, s16 y, s16 z, bool *valid_position)
{
- if(data == NULL)
- throw InvalidPositionException();
- return data[z*MAP_BLOCKSIZE*MAP_BLOCKSIZE + y*MAP_BLOCKSIZE + x];
+ *valid_position = data != nullptr;
+ if (!*valid_position)
+ return {CONTENT_IGNORE};
+
+ return data[z * zstride + y * ystride + x];
+ }
+
+ inline MapNode getNodeNoCheck(v3s16 p, bool *valid_position)
+ {
+ return getNodeNoCheck(p.X, p.Y, p.Z, valid_position);
}
-
- MapNode getNodeNoCheck(v3s16 p)
+
+ ////
+ //// Non-checking, unsafe variants of the above
+ //// MapBlock must be loaded by another function in the same scope/function
+ //// Caller must ensure that this is not a dummy block (by calling isDummy())
+ ////
+
+ inline const MapNode &getNodeUnsafe(s16 x, s16 y, s16 z)
{
- return getNodeNoCheck(p.X, p.Y, p.Z);
+ return data[z * zstride + y * ystride + x];
}
-
- void setNodeNoCheck(s16 x, s16 y, s16 z, MapNode & n)
+
+ inline const MapNode &getNodeUnsafe(v3s16 &p)
{
- if(data == NULL)
+ return getNodeUnsafe(p.X, p.Y, p.Z);
+ }
+
+ inline void setNodeNoCheck(s16 x, s16 y, s16 z, MapNode & n)
+ {
+ if (!data)
throw InvalidPositionException();
- data[z*MAP_BLOCKSIZE*MAP_BLOCKSIZE + y*MAP_BLOCKSIZE + x] = n;
- setChangedFlag();
+
+ data[z * zstride + y * ystride + x] = n;
+ raiseModified(MOD_STATE_WRITE_NEEDED, MOD_REASON_SET_NODE_NO_CHECK);
}
-
- void setNodeNoCheck(v3s16 p, MapNode & n)
+
+ inline void setNodeNoCheck(v3s16 p, MapNode & n)
{
setNodeNoCheck(p.X, p.Y, p.Z, n);
}
- /*
- These functions consult the parent container if the position
- is not valid on this MapBlock.
- */
+ // These functions consult the parent container if the position
+ // is not valid on this MapBlock.
bool isValidPositionParent(v3s16 p);
- MapNode getNodeParent(v3s16 p);
+ MapNode getNodeParent(v3s16 p, bool *is_valid_position = NULL);
void setNodeParent(v3s16 p, MapNode & n);
- MapNode getNodeParentNoEx(v3s16 p);
- void drawbox(s16 x0, s16 y0, s16 z0, s16 w, s16 h, s16 d, MapNode node)
+ inline void drawbox(s16 x0, s16 y0, s16 z0, s16 w, s16 h, s16 d, MapNode node)
{
- for(u16 z=0; z<d; z++)
- for(u16 y=0; y<h; y++)
- for(u16 x=0; x<w; x++)
- setNode(x0+x, y0+y, z0+z, node);
+ for (u16 z = 0; z < d; z++)
+ for (u16 y = 0; y < h; y++)
+ for (u16 x = 0; x < w; x++)
+ setNode(x0 + x, y0 + y, z0 + z, node);
}
- u8 getFaceLight(u32 daynight_ratio, MapNode n, MapNode n2,
- v3s16 face_dir);
-
- u8 getFaceLight(u32 daynight_ratio, v3s16 p, v3s16 face_dir)
+ // Copies data to VoxelManipulator to getPosRelative()
+ void copyTo(VoxelManipulator &dst);
+
+ // Copies data from VoxelManipulator getPosRelative()
+ void copyFrom(VoxelManipulator &dst);
+
+ // Update day-night lighting difference flag.
+ // Sets m_day_night_differs to appropriate value.
+ // These methods don't care about neighboring blocks.
+ void actuallyUpdateDayNightDiff();
+
+ // Call this to schedule what the previous function does to be done
+ // when the value is actually needed.
+ void expireDayNightDiff();
+
+ inline bool getDayNightDiff()
{
- return getFaceLight(daynight_ratio,
- getNodeParentNoEx(p),
- getNodeParentNoEx(p + face_dir),
- face_dir);
+ if (m_day_night_differs_expired)
+ actuallyUpdateDayNightDiff();
+ return m_day_night_differs;
}
-
-#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);
- u8 getNodeContent(v3s16 p, MapNode mn);
- /*
- startpos:
- 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);
-
- void updateMesh(u32 daynight_ratio);
- /*void updateMesh(s32 daynight_i);
- // Updates all DAYNIGHT_CACHE_COUNT meshes
- void updateMeshes(s32 first_i=0);*/
-#endif // !SERVER
-
- // 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);
-
- // Copies data to VoxelManipulator to getPosRelative()
- void copyTo(VoxelManipulator &dst);
+ ////
+ //// Miscellaneous stuff
+ ////
/*
- Object stuff
+ Tries to measure ground level.
+ Return value:
+ -1 = only air
+ -2 = only ground
+ -3 = random fail
+ 0...MAP_BLOCKSIZE-1 = ground level
*/
-
- void serializeObjects(std::ostream &os, u8 version)
+ s16 getGroundLevel(v2s16 p2d);
+
+ ////
+ //// Timestamp (see m_timestamp)
+ ////
+
+ // NOTE: BLOCK_TIMESTAMP_UNDEFINED=0xffffffff means there is no timestamp.
+
+ inline void setTimestamp(u32 time)
{
- m_objects.serialize(os, version);
+ m_timestamp = time;
+ raiseModified(MOD_STATE_WRITE_AT_UNLOAD, MOD_REASON_SET_TIMESTAMP);
}
- // 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()
+ inline void setTimestampNoChangedFlag(u32 time)
{
- m_objects.clear();
-
- setChangedFlag();
+ m_timestamp = time;
}
- void addObject(MapBlockObject *object)
- throw(ContainerFullException, AlreadyExistsException)
- {
- m_objects.add(object);
- setChangedFlag();
- }
- void removeObject(s16 id)
+ inline u32 getTimestamp()
{
- m_objects.remove(id);
-
- setChangedFlag();
+ return m_timestamp;
}
- MapBlockObject * getObject(s16 id)
+
+ inline u32 getDiskTimestamp()
{
- return m_objects.get(id);
+ return m_disk_timestamp;
}
- JMutexAutoLock * getObjectLock()
+
+ ////
+ //// Usage timer (see m_usage_timer)
+ ////
+
+ inline void resetUsageTimer()
{
- return m_objects.getLock();
+ m_usage_timer = 0;
}
- /*
- Moves objects, deletes objects and spawns new objects
- */
- void stepObjects(float dtime, bool server, u32 daynight_ratio);
+ inline void incrementUsageTimer(float dtime)
+ {
+ m_usage_timer += dtime;
+ }
- /*void wrapObject(MapBlockObject *object)
+ inline float getUsageTimer()
{
- m_objects.wrapObject(object);
+ return m_usage_timer;
+ }
- setChangedFlag();
- }*/
+ ////
+ //// Reference counting (see m_refcount)
+ ////
- // origin is relative to block
- void getObjects(v3f origin, f32 max_d,
- core::array<DistanceSortedObject> &dest)
+ inline void refGrab()
{
- m_objects.getObjects(origin, max_d, dest);
+ m_refcount++;
}
- /*void getPseudoObjects(v3f origin, f32 max_d,
- core::array<DistanceSortedObject> &dest);*/
+ inline void refDrop()
+ {
+ m_refcount--;
+ }
- s32 getObjectCount()
+ inline int refGet()
{
- return m_objects.getCount();
+ return m_refcount;
}
-#ifndef SERVER
- /*
- Methods for setting temporary modifications to nodes for
- drawing
+ ////
+ //// Node Timers
+ ////
- returns true if the mod was different last time
- */
- bool setTempMod(v3s16 p, NodeMod mod)
- {
- /*dstream<<"setTempMod called on block"
- <<" ("<<p.X<<","<<p.Y<<","<<p.Z<<")"
- <<", mod.type="<<mod.type
- <<", mod.param="<<mod.param
- <<std::endl;*/
- JMutexAutoLock lock(m_temp_mods_mutex);
-
- // See if old is different, cancel if it is not different.
- core::map<v3s16, NodeMod>::Node *n = m_temp_mods.find(p);
- if(n)
- {
- NodeMod old = n->getValue();
- if(old == mod)
- return false;
- }
-
- m_temp_mods[p] = mod;
- return true;
- }
- // Returns true if there was one
- bool getTempMod(v3s16 p, struct NodeMod *mod)
+ inline NodeTimer getNodeTimer(const v3s16 &p)
{
- JMutexAutoLock lock(m_temp_mods_mutex);
- core::map<v3s16, NodeMod>::Node *n;
- n = m_temp_mods.find(p);
- if(n == NULL)
- return false;
- if(mod)
- *mod = n->getValue();
- return true;
+ return m_node_timers.get(p);
}
- bool clearTempMod(v3s16 p)
+
+ inline void removeNodeTimer(const v3s16 &p)
{
- JMutexAutoLock lock(m_temp_mods_mutex);
- if(m_temp_mods.find(p))
- {
- m_temp_mods.remove(p);
- return true;
- }
- return false;
+ m_node_timers.remove(p);
}
- bool clearTempMods()
+
+ inline void setNodeTimer(const NodeTimer &t)
{
- JMutexAutoLock lock(m_temp_mods_mutex);
- if(m_temp_mods.size() == 0)
- return false;
- m_temp_mods.clear();
- return true;
+ m_node_timers.set(t);
}
-#endif
- /*
- Day-night lighting difference
-
- These methods don't care about neighboring blocks.
- It means that to know if a block really doesn't need a mesh
- update between day and night, the neighboring blocks have
- to be taken into account. Use Map::dayNightDiffed().
- */
- void updateDayNightDiff();
-
- bool dayNightDiffed()
+ inline void clearNodeTimers()
{
- return m_day_night_differs;
+ m_node_timers.clear();
}
- /*
- Miscellaneous stuff
- */
-
- /*
- Tries to measure ground level.
- Return value:
- -1 = only air
- -2 = only ground
- -3 = random fail
- 0...MAP_BLOCKSIZE-1 = ground level
- */
- s16 getGroundLevel(v2s16 p2d);
-
- /*
- Serialization
- */
-
- // Doesn't write version by itself
- void serialize(std::ostream &os, u8 version);
+ ////
+ //// Serialization
+ ///
- void deSerialize(std::istream &is, u8 version);
+ // These don't write or read version by itself
+ // Set disk to true for on-disk format, false for over-the-network format
+ // Precondition: version >= SER_FMT_VER_LOWEST_WRITE
+ void serialize(std::ostream &os, u8 version, bool disk);
+ // If disk == true: In addition to doing other things, will add
+ // unknown blocks from id-name mapping to wndef
+ void deSerialize(std::istream &is, u8 version, bool disk);
+ void serializeNetworkSpecific(std::ostream &os);
+ void deSerializeNetworkSpecific(std::istream &is);
+private:
/*
- Public member variables
+ Private methods
*/
-#ifndef SERVER
- //scene::SMesh *mesh[DAYNIGHT_CACHE_COUNT];
- scene::SMesh *mesh;
- JMutex mesh_mutex;
-#endif
-
-private:
+ void deSerialize_pre22(std::istream &is, u8 version, bool disk);
/*
Used only internally, because changes can't be tracked
*/
- MapNode & getNodeRef(s16 x, s16 y, s16 z)
+ inline MapNode &getNodeRef(s16 x, s16 y, s16 z)
{
- if(data == NULL)
+ if (!isValidPosition(x, y, z))
throw InvalidPositionException();
- if(x < 0 || x >= MAP_BLOCKSIZE) throw InvalidPositionException();
- if(y < 0 || y >= MAP_BLOCKSIZE) throw InvalidPositionException();
- if(z < 0 || z >= MAP_BLOCKSIZE) throw InvalidPositionException();
- return data[z*MAP_BLOCKSIZE*MAP_BLOCKSIZE + y*MAP_BLOCKSIZE + x];
+
+ return data[z * zstride + y * ystride + x];
}
- MapNode & getNodeRef(v3s16 &p)
+
+ inline MapNode &getNodeRef(v3s16 &p)
{
return getNodeRef(p.X, p.Y, p.Z);
}
-
- NodeContainer *m_parent;
+public:
+ /*
+ Public member variables
+ */
+
+#ifndef SERVER // Only on client
+ MapBlockMesh *mesh = nullptr;
+#endif
+
+ NodeMetadataList m_node_metadata;
+ NodeTimerList m_node_timers;
+ StaticObjectList m_static_objects;
+
+ static const u32 ystride = MAP_BLOCKSIZE;
+ static const u32 zstride = MAP_BLOCKSIZE * MAP_BLOCKSIZE;
+
+ static const u32 nodecount = MAP_BLOCKSIZE * MAP_BLOCKSIZE * MAP_BLOCKSIZE;
+
+ //// ABM optimizations ////
+ // Cache of content types
+ std::unordered_set<content_t> contents;
+ // True if content types are cached
+ bool contents_cached = false;
+ // True if we never want to cache content types for this block
+ bool do_not_cache_contents = false;
+
+private:
+ /*
+ Private member variables
+ */
+
+ // NOTE: Lots of things rely on this being the Map
+ Map *m_parent;
// Position in blocks on parent
v3s16 m_pos;
+
+ /* This is the precalculated m_pos_relative value
+ * This caches the value, improving performance by removing 3 s16 multiplications
+ * at runtime on each getPosRelative call
+ * For a 5 minutes runtime with valgrind this removes 3 * 19M s16 multiplications
+ * The gain can be estimated in Release Build to 3 * 100M multiply operations for 5 mins
+ */
+ v3s16 m_pos_relative;
+
+ IGameDef *m_gamedef;
+
/*
If NULL, block is a dummy block.
Dummy blocks are used for caching not-found-on-disk blocks.
*/
- MapNode * data;
+ MapNode *data = nullptr;
+
/*
- - On the client, this is used for checking whether to
- recalculate the face cache. (Is it anymore?)
- 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 = MOD_STATE_WRITE_NEEDED;
+ u32 m_modified_reason = MOD_REASON_INITIAL;
+
/*
- Used for some initial lighting stuff.
- At least /has been/ used. 8)
- It's probably useless now.
+ When propagating sunlight and the above block doesn't exist,
+ sunlight is assumed if this is false.
+
+ In practice this is set to true if the block is completely
+ undeground with nothing visible above the ground except
+ caves.
+ */
+ bool is_underground = false;
+
+ /*!
+ * Each bit indicates if light spreading was finished
+ * in a direction. (Because the neighbor could also be unloaded.)
+ * Bits (most significant first):
+ * nothing, nothing, nothing, nothing,
+ * night X-, night Y-, night Z-, night Z+, night Y+, night X+,
+ * day X-, day Y-, day Z-, day Z+, day Y+, day X+.
*/
- bool is_underground;
-
+ u16 m_lighting_complete = 0xFFFF;
+
// Whether day and night lighting differs
- bool m_day_night_differs;
-
- MapBlockObjectList m_objects;
-
- // Object spawning stuff
- float m_spawn_timer;
-
-#ifndef SERVER
- bool m_mesh_expired;
-
- // Temporary modifications to nodes
- // These are only used when drawing
- core::map<v3s16, NodeMod> m_temp_mods;
- JMutex m_temp_mods_mutex;
-#endif
+ bool m_day_night_differs = false;
+ bool m_day_night_differs_expired = true;
+
+ bool m_generated = false;
+
+ /*
+ 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 = BLOCK_TIMESTAMP_UNDEFINED;
+ // The on-disk (or to-be on-disk) timestamp value
+ u32 m_disk_timestamp = BLOCK_TIMESTAMP_UNDEFINED;
+
+ /*
+ When the block is accessed, this is set to 0.
+ Map will unload the block when this reaches a timeout.
+ */
+ float m_usage_timer = 0;
+
+ /*
+ Reference count; currently used for determining if this block is in
+ the list of blocks to be drawn.
+ */
+ int m_refcount = 0;
};
-inline bool blockpos_over_limit(v3s16 p)
+typedef std::vector<MapBlock*> MapBlockVect;
+
+inline bool objectpos_over_limit(v3f p)
{
- return
- (p.X < -MAP_GENERATION_LIMIT / MAP_BLOCKSIZE
- || p.X > MAP_GENERATION_LIMIT / MAP_BLOCKSIZE
- || p.Y < -MAP_GENERATION_LIMIT / MAP_BLOCKSIZE
- || p.Y > MAP_GENERATION_LIMIT / MAP_BLOCKSIZE
- || p.Z < -MAP_GENERATION_LIMIT / MAP_BLOCKSIZE
- || p.Z > MAP_GENERATION_LIMIT / MAP_BLOCKSIZE);
+ const float max_limit_bs = MAX_MAP_GENERATION_LIMIT * BS;
+ return p.X < -max_limit_bs ||
+ p.X > max_limit_bs ||
+ p.Y < -max_limit_bs ||
+ p.Y > max_limit_bs ||
+ p.Z < -max_limit_bs ||
+ p.Z > max_limit_bs;
}
-/*
- Returns the position of the block where the node is located
-*/
-inline v3s16 getNodeBlockPos(v3s16 p)
+inline bool blockpos_over_max_limit(v3s16 p)
{
- return getContainerPos(p, MAP_BLOCKSIZE);
+ const s16 max_limit_bp = MAX_MAP_GENERATION_LIMIT / MAP_BLOCKSIZE;
+ return p.X < -max_limit_bp ||
+ p.X > max_limit_bp ||
+ p.Y < -max_limit_bp ||
+ p.Y > max_limit_bp ||
+ p.Z < -max_limit_bp ||
+ p.Z > max_limit_bp;
}
-inline v2s16 getNodeSectorPos(v2s16 p)
+/*
+ Returns the position of the block where the node is located
+*/
+inline v3s16 getNodeBlockPos(const v3s16 &p)
{
return getContainerPos(p, MAP_BLOCKSIZE);
}
-inline s16 getNodeBlockY(s16 y)
+inline void getNodeBlockPosWithOffset(const v3s16 &p, v3s16 &block, v3s16 &offset)
{
- return getContainerPos(y, MAP_BLOCKSIZE);
+ getContainerPosWithOffset(p, MAP_BLOCKSIZE, block, offset);
}
-#endif
-
+/*
+ Get a quick string to describe what a block actually contains
+*/
+std::string analyze_block(MapBlock *block);