Map Class Reference

#include <map.h>

Inheritance diagram for Map:

Collaboration diagram for Map:

Public Member Functions
	Map (IGameDef *gamedef)
virtual	~Map ()
	DISABLE_CLASS_COPY (Map)
void	addEventReceiver (MapEventReceiver *event_receiver)
void	removeEventReceiver (MapEventReceiver *event_receiver)
void	dispatchEvent (const MapEditEvent &event)
MapSector *	getSectorNoGenerateNoLock (v2s16 p2d)
MapSector *	getSectorNoGenerate (v2s16 p2d)
virtual MapSector *	emergeSector (v2s16 p)
MapBlock *	getBlockNoCreate (v3s16 p)
MapBlock *	getBlockNoCreateNoEx (v3s16 p)
virtual MapBlock *	emergeBlock (v3s16 p, bool create_blank=true)
const NodeDefManager *	getNodeDefManager ()
bool	isValidPosition (v3s16 p)
void	setNode (v3s16 p, MapNode n)
MapNode	getNode (v3s16 p, bool *is_valid_position=NULL)
virtual void	addNodeAndUpdate (v3s16 p, MapNode n, std::map< v3s16, MapBlock * > &modified_blocks, bool remove_metadata=true)
void	removeNodeAndUpdate (v3s16 p, std::map< v3s16, MapBlock * > &modified_blocks)
bool	addNodeWithEvent (v3s16 p, MapNode n, bool remove_metadata=true)
bool	removeNodeWithEvent (v3s16 p)
virtual void	beginSave ()
virtual void	endSave ()
virtual void	save (ModifiedState save_level)
virtual bool	maySaveBlocks ()
virtual bool	saveBlock (MapBlock *block)
virtual bool	deleteBlock (v3s16 blockpos)
void	timerUpdate (float dtime, float unload_timeout, s32 max_loaded_blocks, std::vector< v3s16 > *unloaded_blocks=NULL)
void	unloadUnreferencedBlocks (std::vector< v3s16 > *unloaded_blocks=NULL)
void	deleteSectors (const std::vector< v2s16 > &list)
virtual void	PrintInfo (std::ostream &out)
std::vector< v3s16 >	findNodesWithMetadata (v3s16 p1, v3s16 p2)
NodeMetadata *	getNodeMetadata (v3s16 p)
bool	setNodeMetadata (v3s16 p, NodeMetadata *meta)
	Sets metadata for a node.
void	removeNodeMetadata (v3s16 p)
NodeTimer	getNodeTimer (v3s16 p)
void	setNodeTimer (const NodeTimer &t)
void	removeNodeTimer (v3s16 p)
template<typename F>
void	forEachNodeInArea (v3s16 minp, v3s16 maxp, F func)
bool	isBlockOccluded (MapBlock *block, v3s16 cam_pos_nodes)
bool	isBlockOccluded (v3s16 pos_relative, v3s16 cam_pos_nodes, bool simple_check=false)

Protected Member Functions
virtual void	reportMetrics (u64 save_time_us, u32 saved_blocks, u32 all_blocks)
bool	determineAdditionalOcclusionCheck (v3s16 pos_camera, const core::aabbox3d< s16 > &block_bounds, v3s16 &to_check)
bool	isOccluded (v3s16 pos_camera, v3s16 pos_target, float step, float stepfac, float start_offset, float end_offset, u32 needed_count)

Protected Attributes
IGameDef *	m_gamedef
std::set< MapEventReceiver * >	m_event_receivers
std::unordered_map< v2s16, MapSector * >	m_sectors
MapSector *	m_sector_cache = nullptr
v2s16	m_sector_cache_p
const NodeDefManager *	m_nodedef

Constructor & Destructor Documentation

Map()

Map::Map

(

IGameDef *

gamedef

)

References m_gamedef, and m_nodedef.

Referenced by ClientMap::ClientMap(), DummyMap::DummyMap(), ServerMap::ServerMap(), and DISABLE_CLASS_COPY().

Here is the caller graph for this function:

~Map()

Map::~Map ( )

virtual

References infostream, m_sectors, PrintInfo(), and warningstream.

Here is the call graph for this function:

Member Function Documentation

addEventReceiver()

void Map::addEventReceiver

(

MapEventReceiver *

event_receiver

)

References m_event_receivers.

addNodeAndUpdate()

void Map::addNodeAndUpdate ( v3s16 p, MapNode n, std::map< v3s16, MapBlock * > & modified_blocks, bool remove_metadata = true )

virtual

Reimplemented in ServerMap.

References CONTENT_AIR, MapBlock::expireIsAirCache(), getBlockNoCreate(), MapNode::getContent(), MapNode::getLightRaw(), getNodeBlockPos(), MapBlock::getNodeNoCheck(), LIGHTBANK_DAY, LIGHTBANK_NIGHT, m_gamedef, m_nodedef, MAP_BLOCKSIZE, p(), removeNodeMetadata(), set_node_in_block(), MapNode::setLight(), RollbackAction::setSetNode(), and voxalgo::update_lighting_nodes().

Referenced by ServerMap::addNodeAndUpdate(), addNodeWithEvent(), removeNodeAndUpdate(), TEST_CASE(), and TestVoxelAlgorithms::testLighting().

Here is the call graph for this function:

Here is the caller graph for this function:

addNodeWithEvent()

bool Map::addNodeWithEvent	(	v3s16	p,
		MapNode	n,
		bool	remove_metadata = true )

References addNodeAndUpdate(), dispatchEvent(), MEET_ADDNODE, MEET_SWAPNODE, p(), and MapEditEvent::type.

Referenced by RollbackAction::applyRevert().

Here is the call graph for this function:

Here is the caller graph for this function:

beginSave()

virtual void Map::beginSave ( )

inlinevirtual

Reimplemented in ServerMap.

Referenced by timerUpdate().

Here is the caller graph for this function:

deleteBlock()

virtual bool Map::deleteBlock ( v3s16 blockpos )

inlinevirtual

Reimplemented in ServerMap.

deleteSectors()

void Map::deleteSectors

(

const std::vector< v2s16 > &

list

)

References m_sector_cache, and m_sectors.

Referenced by timerUpdate().

Here is the caller graph for this function:

determineAdditionalOcclusionCheck()

bool Map::determineAdditionalOcclusionCheck ( v3s16 pos_camera, const core::aabbox3d< s16 > & block_bounds, v3s16 & to_check )

protected

References CLOSEST_EDGE.

Referenced by isBlockOccluded().

Here is the caller graph for this function:

DISABLE_CLASS_COPY()

Map::DISABLE_CLASS_COPY

(

Map

)

References Map().

Here is the call graph for this function:

dispatchEvent()

void Map::dispatchEvent

(

const MapEditEvent &

event

)

References m_event_receivers.

Referenced by addNodeWithEvent(), RollbackAction::applyRevert(), ModApiEnv::l_delete_area(), ModApiEnv::l_fix_light(), LuaVoxelManip::l_write_to_map(), ServerMap::loadBlock(), Schematic::placeOnMap(), removeNodeWithEvent(), and treegen::spawn_ltree().

Here is the caller graph for this function:

emergeBlock()

virtual MapBlock * Map::emergeBlock ( v3s16 p, bool create_blank = true )

inlinevirtual

Reimplemented in ServerMap.

References getBlockNoCreateNoEx(), and p().

Referenced by RollbackAction::applyRevert(), findNodesWithMetadata(), getNodeMetadata(), getNodeTimer(), voxalgo::is_sunlight_above_block(), ModApiEnv::l_load_area(), setNodeMetadata(), setNodeTimer(), TestSAO::testActivate(), TestSAO::testNotSaved(), and TestSAO::testStaticToFalse().

Here is the call graph for this function:

Here is the caller graph for this function:

emergeSector()

virtual MapSector * Map::emergeSector ( v2s16 p )

inlinevirtual

Reimplemented in ClientMap.

References p().

Here is the call graph for this function:

endSave()

virtual void Map::endSave ( )

inlinevirtual

Reimplemented in ServerMap.

Referenced by timerUpdate().

Here is the caller graph for this function:

findNodesWithMetadata()

std::vector< v3s16 > Map::findNodesWithMetadata	(	v3s16	p1,
		v3s16	p2 )

References VoxelArea::contains(), emergeBlock(), NodeMetadataList::getAllKeys(), getBlockNoCreateNoEx(), getNodeBlockPos(), infostream, MapBlock::m_node_metadata, MAP_BLOCKSIZE, p(), sortBoxVerticies(), verbosestream, x, y, and z.

Here is the call graph for this function:

forEachNodeInArea()

template<typename F>

void Map::forEachNodeInArea ( v3s16 minp, v3s16 maxp, F func )

inline

References CONTENT_IGNORE, getBlockNoCreateNoEx(), getNodeBlockPos(), MapBlock::getNodeNoCheck(), MAP_BLOCKSIZE, p(), and rangelim().

Referenced by ModApiEnv::l_find_nodes_in_area(), TestMap::testForEachNodeInArea(), TestMap::testForEachNodeInAreaBlank(), and TestMap::testForEachNodeInAreaEmpty().

Here is the call graph for this function:

Here is the caller graph for this function:

getBlockNoCreate()

MapBlock * Map::getBlockNoCreate

(

v3s16

p

)

References getBlockNoCreateNoEx().

Referenced by addNodeAndUpdate(), and setNode().

Here is the call graph for this function:

Here is the caller graph for this function:

getBlockNoCreateNoEx()

MapBlock * Map::getBlockNoCreateNoEx

(

v3s16

p

)

References MapSector::getBlockNoCreateNoEx(), and getSectorNoGenerate().

Referenced by add_area_node_boxes(), MeshUpdateQueue::addBlock(), voxalgo::blit_back_with_light(), ServerMap::cancelBlockMake(), ABMHandler::countObjects(), ServerEnvironment::deactivateFarObjects(), ServerMap::deleteBlock(), emergeBlock(), ServerMap::emergeBlock(), DummyMap::fill(), findNodesWithMetadata(), voxalgo::finish_bulk_light_update(), ServerMap::finishBlockMake(), forEachNodeInArea(), getBlockNoCreate(), ServerMap::getBlockOrEmerge(), RemoteClient::GetNextBlocks(), getNode(), getNodeMetadata(), getNodeTimer(), voxalgo::is_sunlight_above(), voxalgo::is_sunlight_above_block(), ClientMap::isMeshOccluded(), isValidPosition(), ServerMap::loadBlock(), voxalgo::propagate_block_sunlight(), readBlocks(), readRandomBlocks(), readYColumn(), removeNodeMetadata(), removeNodeTimer(), voxalgo::repair_block_light(), QueuedMeshUpdate::retrieveBlocks(), Server::SendBlocks(), setNodeMetadata(), setNodeTimer(), voxalgo::spread_light(), TestSAO::testStaticSave(), TestSAO::testStaticToTrue(), ServerMap::transformLiquidsLocal(), voxalgo::unspread_light(), voxalgo::update_block_border_lighting(), voxalgo::update_lighting_nodes(), and ClientMap::updateDrawList().

Here is the call graph for this function:

Here is the caller graph for this function:

getNode()

MapNode Map::getNode	(	v3s16	p,
		bool *	is_valid_position = NULL )

References CONTENT_IGNORE, getBlockNoCreateNoEx(), getNodeBlockPos(), MapBlock::getNodeNoCheck(), MAP_BLOCKSIZE, and p().

Referenced by RollbackNode::RollbackNode(), SmokePuffCSO::SmokePuffCSO(), ServerMap::addNodeAndUpdate(), ABMHandler::apply(), RollbackAction::applyRevert(), Environment::continueRaycast(), Server::findSpawnPos(), ClientMap::getBackgroundBrightness(), getNeighborConnectingFace(), LocalPlayer::getSlipFactor(), getVisibleBrightness(), LocalPlayer::handleAutojump(), Game::handleDigging(), Game::handlePointingAtNode(), voxalgo::is_light_locally_correct(), isOccluded(), ModApiEnv::l_find_node_near(), ModApiEnv::l_find_nodes_in_area_under_air(), Environment::line_of_sight(), LocalPlayer::move(), ScriptApiNode::node_on_receive_fields(), ScriptApiNodemeta::nodemeta_inventory_AllowMove(), ScriptApiNodemeta::nodemeta_inventory_AllowPut(), ScriptApiNodemeta::nodemeta_inventory_AllowTake(), ScriptApiNodemeta::nodemeta_inventory_OnMove(), ScriptApiNodemeta::nodemeta_inventory_OnPut(), ScriptApiNodemeta::nodemeta_inventory_OnTake(), Game::nodePlacement(), LocalPlayer::old_move(), readNodes(), ClientMap::renderPostFx(), TestMap::testForEachNodeInAreaBlank(), TestVoxelAlgorithms::testLighting(), ServerMap::transformLiquidsLocal(), GameUI::update(), voxalgo::update_lighting_nodes(), ClientMap::updateDrawList(), Particle::updateLight(), Game::updatePointedThing(), LocalPlayer::updateSneakNode(), Game::updateSound(), and ServerMap::updateVManip().

Here is the call graph for this function:

Here is the caller graph for this function:

getNodeDefManager()

const NodeDefManager * Map::getNodeDefManager ( )

inline

References m_nodedef.

Referenced by voxalgo::blit_back_with_light(), Environment::continueRaycast(), voxalgo::finish_bulk_light_update(), MapNode::getNeighbors(), voxalgo::repair_block_light(), voxalgo::update_block_border_lighting(), voxalgo::update_lighting_nodes(), and Game::updatePointedThing().

Here is the caller graph for this function:

getNodeMetadata()

NodeMetadata * Map::getNodeMetadata

(

v3s16

p

)

References emergeBlock(), NodeMetadataList::get(), getBlockNoCreateNoEx(), getNodeBlockPos(), infostream, MapBlock::m_node_metadata, MAP_BLOCKSIZE, p(), and warningstream.

Referenced by RollbackNode::RollbackNode(), RollbackAction::applyRevert(), Game::handlePointingAtNode(), and ModApiClient::l_get_meta().

Here is the call graph for this function:

Here is the caller graph for this function:

getNodeTimer()

NodeTimer Map::getNodeTimer

(

v3s16

p

)

References NodeTimer::elapsed, emergeBlock(), getBlockNoCreateNoEx(), getNodeBlockPos(), MapBlock::getNodeTimer(), infostream, MAP_BLOCKSIZE, p(), NodeTimer::timeout, and warningstream.

Referenced by NodeTimerRef::l_get_elapsed(), NodeTimerRef::l_get_timeout(), and NodeTimerRef::l_is_started().

Here is the call graph for this function:

Here is the caller graph for this function:

getSectorNoGenerate()

MapSector * Map::getSectorNoGenerate

(

v2s16

p2d

)

References getSectorNoGenerateNoLock(), and p().

Referenced by ServerMap::createSector(), ServerMap::deleteBlock(), ClientMap::emergeSector(), and getBlockNoCreateNoEx().

Here is the call graph for this function:

Here is the caller graph for this function:

getSectorNoGenerateNoLock()

MapSector * Map::getSectorNoGenerateNoLock

(

v2s16

p2d

)

References m_sector_cache, m_sector_cache_p, m_sectors, and p().

Referenced by getSectorNoGenerate().

Here is the call graph for this function:

Here is the caller graph for this function:

isBlockOccluded() [1/2]

bool Map::isBlockOccluded ( MapBlock * block, v3s16 cam_pos_nodes )

inline

References MapBlock::getPosRelative(), and isBlockOccluded().

Referenced by RemoteClient::GetNextBlocks(), isBlockOccluded(), and ClientMap::isMeshOccluded().

Here is the call graph for this function:

Here is the caller graph for this function:

isBlockOccluded() [2/2]

bool Map::isBlockOccluded	(	v3s16	pos_relative,
		v3s16	cam_pos_nodes,
		bool	simple_check = false )

References BS, determineAdditionalOcclusionCheck(), dir(), MapBlock::getBox(), isOccluded(), MAP_BLOCKSIZE, and myrand_range().

Here is the call graph for this function:

isOccluded()

bool Map::isOccluded ( v3s16 pos_camera, v3s16 pos_target, float step, float stepfac, float start_offset, float end_offset, u32 needed_count )

protected

References BS, floatToInt(), getNode(), intToFloat(), and m_nodedef.

Referenced by isBlockOccluded().

Here is the call graph for this function:

Here is the caller graph for this function:

isValidPosition()

bool Map::isValidPosition

(

v3s16

p

)

References getBlockNoCreateNoEx(), getNodeBlockPos(), and p().

Referenced by Client::handleCommand_NodemetaChanged().

Here is the call graph for this function:

Here is the caller graph for this function:

maySaveBlocks()

virtual bool Map::maySaveBlocks ( )

inlinevirtual

Reimplemented in ClientMap, and DummyMap.

Referenced by timerUpdate().

Here is the caller graph for this function:

PrintInfo()

void Map::PrintInfo ( std::ostream & out )

virtual

Reimplemented in ClientMap, and ServerMap.

Referenced by ~Map(), and timerUpdate().

Here is the caller graph for this function:

removeEventReceiver()

void Map::removeEventReceiver

(

MapEventReceiver *

event_receiver

)

References m_event_receivers.

removeNodeAndUpdate()

void Map::removeNodeAndUpdate	(	v3s16	p,
		std::map< v3s16, MapBlock * > &	modified_blocks )

References addNodeAndUpdate(), CONTENT_AIR, and p().

Referenced by removeNodeWithEvent(), and TEST_CASE().

Here is the call graph for this function:

Here is the caller graph for this function:

removeNodeMetadata()

void Map::removeNodeMetadata

(

v3s16

p

)

References getBlockNoCreateNoEx(), getNodeBlockPos(), MapBlock::m_node_metadata, MAP_BLOCKSIZE, p(), NodeMetadataList::remove(), and warningstream.

Referenced by addNodeAndUpdate(), and RollbackAction::applyRevert().

Here is the call graph for this function:

Here is the caller graph for this function:

removeNodeTimer()

void Map::removeNodeTimer

(

v3s16

p

)

References getBlockNoCreateNoEx(), getNodeBlockPos(), MAP_BLOCKSIZE, p(), MapBlock::removeNodeTimer(), and warningstream.

Referenced by NodeTimerRef::l_stop().

Here is the call graph for this function:

Here is the caller graph for this function:

removeNodeWithEvent()

bool Map::removeNodeWithEvent

(

v3s16

p

)

References dispatchEvent(), MEET_REMOVENODE, p(), removeNodeAndUpdate(), and MapEditEvent::type.

Here is the call graph for this function:

reportMetrics()

virtual void Map::reportMetrics ( u64 save_time_us, u32 saved_blocks, u32 all_blocks )

inlineprotectedvirtual

Reimplemented in ClientMap, and ServerMap.

Referenced by timerUpdate().

Here is the caller graph for this function:

save()

virtual void Map::save ( ModifiedState save_level )

inlinevirtual

Reimplemented in ServerMap.

References FATAL_ERROR.

saveBlock()

virtual bool Map::saveBlock ( MapBlock * block )

inlinevirtual

Reimplemented in ServerMap.

Referenced by timerUpdate().

Here is the caller graph for this function:

setNode()

void Map::setNode	(	v3s16	p,
		MapNode	n )

References getBlockNoCreate(), getNodeBlockPos(), m_gamedef, MAP_BLOCKSIZE, p(), and set_node_in_block().

Referenced by TestMap::testForEachNodeInArea(), ServerMap::transformLiquidsLocal(), and voxalgo::update_lighting_nodes().

Here is the call graph for this function:

Here is the caller graph for this function:

setNodeMetadata()

bool Map::setNodeMetadata	(	v3s16	p,
		NodeMetadata *	meta )

Sets metadata for a node.

This method sets the metadata for a given node. On success, it returns true and the object pointed to by meta is then managed by the system and should not be deleted by the caller.

In case of failure, the method returns false and the caller is still responsible for deleting the object!

Parameters

p	node coordinates
meta	pointer to NodeMetadata object

Returns

true on success, false on failure

References emergeBlock(), getBlockNoCreateNoEx(), getNodeBlockPos(), infostream, MapBlock::m_node_metadata, MAP_BLOCKSIZE, p(), NodeMetadataList::set(), and warningstream.

Referenced by RollbackAction::applyRevert(), and Client::handleCommand_NodemetaChanged().

Here is the call graph for this function:

Here is the caller graph for this function:

setNodeTimer()

void Map::setNodeTimer

(

const NodeTimer &

t

)

References NodeTimer::elapsed, emergeBlock(), getBlockNoCreateNoEx(), getNodeBlockPos(), infostream, MAP_BLOCKSIZE, p(), NodeTimer::position, MapBlock::setNodeTimer(), NodeTimer::timeout, and warningstream.

Referenced by NodeTimerRef::l_set(), and NodeTimerRef::l_start().

Here is the call graph for this function:

Here is the caller graph for this function:

timerUpdate()

void Map::timerUpdate	(	float	dtime,
		float	unload_timeout,
		s32	max_loaded_blocks,
		std::vector< v3s16 > *	unloaded_blocks = NULL )

References Profiler::add(), beginSave(), TimeOrderedMapBlock::block, MapSector::deleteBlock(), deleteSectors(), endSave(), MapSector::getBlocks(), MapBlock::getModified(), MapBlock::getModifiedReasonString(), MapBlock::getPos(), porting::getTimeUs(), MapBlock::incrementUsageTimer(), infostream, m_sectors, maySaveBlocks(), MOD_STATE_CLEAN, p(), Profiler::print(), PrintInfo(), MapBlock::refGet(), reportMetrics(), saveBlock(), and TimeOrderedMapBlock::sect.

Referenced by TestSAO::testNotSaved(), TestSAO::testStaticToFalse(), and unloadUnreferencedBlocks().

Here is the call graph for this function:

Here is the caller graph for this function:

unloadUnreferencedBlocks()

void Map::unloadUnreferencedBlocks

(

std::vector< v3s16 > *

unloaded_blocks = NULL

)

References timerUpdate().

Here is the call graph for this function:

Member Data Documentation

m_event_receivers

std::set<MapEventReceiver*> Map::m_event_receivers

protected

Referenced by addEventReceiver(), dispatchEvent(), and removeEventReceiver().

m_gamedef

IGameDef* Map::m_gamedef

protected

Referenced by Map(), addNodeAndUpdate(), ServerMap::createSector(), ClientMap::emergeSector(), setNode(), and ServerMap::transformLiquidsLocal().

m_nodedef

const NodeDefManager* Map::m_nodedef

protected

Referenced by Map(), addNodeAndUpdate(), ServerMap::addNodeAndUpdate(), ClientMap::getBackgroundBrightness(), getNodeDefManager(), ServerMap::initBlockMake(), isOccluded(), ClientMap::renderMapShadows(), ClientMap::renderPostFx(), ServerMap::transformLiquidsLocal(), and ClientMap::updateDrawList().

m_sector_cache

MapSector* Map::m_sector_cache = nullptr

protected

Referenced by deleteSectors(), and getSectorNoGenerateNoLock().

m_sector_cache_p

v2s16 Map::m_sector_cache_p

protected

Referenced by getSectorNoGenerateNoLock().

m_sectors

std::unordered_map<v2s16, MapSector*> Map::m_sectors

protected

Referenced by ~Map(), ServerMap::createSector(), deleteSectors(), ClientMap::emergeSector(), getSectorNoGenerateNoLock(), ServerMap::listAllLoadedBlocks(), ServerMap::save(), timerUpdate(), ClientMap::touchMapBlocks(), ClientMap::updateDrawList(), and ClientMap::updateDrawListShadow().

---

The documentation for this class was generated from the following files:

• map.h
• map.cpp