Add method set_node_visual and get_node_visual to player Lua object and needed logic around it to allow game to set variant_offset

Author: sfence

doc/lua_api.md

@@ -9058,6 +9058,13 @@ child will follow movement and rotation of that bone.
 
 * `get_lighting()`: returns the current state of lighting for the player.
     * Result is a table with the same fields as `light_definition` in `set_lighting`.
+* `set_node_visual(node_name, node_visual)`: sets `node_visual` of `node_name` for the player
+    * `node_name` is a name of registered node.
+    * `node_visual` is a table with the following optional fields:
+      * `variant_offset` this value is added to variant from node param2 value (default: `0`).
+
+* `get_node_visual(node_name)`: returns the current `node_visual` of `node_name` for the player.
+    * Result is a table with the same fields as `node_visual` in `set_node_visual`.
 * `respawn()`: Respawns the player using the same mechanism as the death screen,
   including calling `on_respawnplayer` callbacks.
 * `get_flags()`: returns a table of player flags (the following boolean fields):

games/devtest/mods/testnodes/init.lua

@@ -12,3 +12,4 @@ dofile(path.."/textures.lua")
 dofile(path.."/overlays.lua")
 dofile(path.."/variants.lua")
 dofile(path.."/commands.lua")
+dofile(path.."/node_visual.lua")

games/devtest/mods/testnodes/node_visual.lua

@@ -0,0 +1,48 @@
+-- add command to change node_visual
+
+core.register_chatcommand("node_visual", {
+	params = "nodename field [value]",
+	description = "Change node_visual field of actual player to value or show value of field.",
+	func = function(name, param)
+		local player = core.get_player_by_name(name)
+		if not player then
+			return false, "No player."
+		end
+
+		local splits = string.split(param, " ", false, 3)
+
+		if #splits < 2 then
+			return false, "Expected node name and node_visual field as parameters."
+		end
+
+		local node_name = splits[1]
+		local field_name = splits[2]
+
+		if not core.registered_nodes[node_name] then
+			return false, "Unknown node "..node_name
+		end
+
+		local node_visual = player:get_node_visual(node_name)
+		
+		if rawequal(node_visual[field_name], nil) then
+			return false, "Field "..field_name.." not found in node_visual."
+		end
+		
+		if #splits > 2 then
+			if type(node_visual[field_name]) == "number" then
+				node_visual[field_name] = tonumber(splits[3])
+			elseif type(node_visual[field_name]) == "table" then
+				node_visual[field_name] = core.parse_json(splits[3])
+				if type(node_visual[field_name]) ~= "table" then
+					return false, "Table in json format is expected as value."
+				end
+			else
+				node_visual[field_name] = splits[3]
+			end
+			player:set_node_visual(node_name, node_visual)
+			return true, "Node "..node_name.." node_visual field "..field_name.." set to value: "..dump(node_visual[field_name])
+		else
+			return true, "Node "..node_name.." node_visual field "..field_name.." have value: "..dump(node_visual[field_name])
+		end
+	end
+})

games/devtest/mods/unittests/player.lua

@@ -204,3 +204,12 @@ local function run_player_hotbar_clamp_tests(player)
 	player:hud_set_hotbar_itemcount(old_bar_size)
 end
 unittests.register("test_player_hotbar_clamp", run_player_hotbar_clamp_tests, {player=true})
+
+unittests.register("test_player_node_visual", function (player)
+		local visual = player:get_node_visual("testnodes:variant_facedir")
+		player:set_node_visual("testnodes:variant_facedir",
+				{variant_offset = 5})
+		local set_visual = player:get_node_visual("testnodes:variant_facedir")
+		assert(set_visual.variant_offset == 5)
+		player:set_node_visual("testnodes:variant_facedir", visual)
+	end, {player = true})

src/client/client.cpp

@@ -1764,6 +1764,18 @@ void Client::addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server, bool ur
 		addUpdateMeshTask(blockpos + v3s16(0, 0, -1), false, urgent);
 }
 
+void Client::updateDrawListBlocks(bool ack_to_server, bool urgent)
+{
+	Map *map = &m_env.getMap();
+	ClientMap *client_map = dynamic_cast<ClientMap*>(map);
+
+	auto cb_updateBlock = [this, map, ack_to_server, urgent] (v3s16 block_pos, MapBlock *map_block) {
+		m_mesh_update_manager->updateBlock(map, block_pos, ack_to_server, urgent);
+	};
+
+	client_map->callOverDrawList(cb_updateBlock);
+}
+
 ClientEvent *Client::getClientEvent()
 {
 	FATAL_ERROR_IF(m_client_event_queue.empty(),

src/client/client.h

@@ -219,6 +219,7 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 	void handleCommand_MinimapModes(NetworkPacket *pkt);
 	void handleCommand_SetLighting(NetworkPacket *pkt);
 	void handleCommand_Camera(NetworkPacket* pkt);
+	void handleCommand_SetNodeVisual(NetworkPacket *pkt);
 
 	void ProcessData(NetworkPacket *pkt);
 
@@ -305,6 +306,8 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 	void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
 	void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
 
+	void updateDrawListBlocks(bool ack_to_server=false, bool urgent=false);
+
 	bool hasClientEvents() const { return !m_client_event_queue.empty(); }
 	// Get event from queue. If queue is empty, it triggers an assertion failure.
 	ClientEvent * getClientEvent();

src/client/clientmap.cpp

@@ -711,6 +711,13 @@ void ClientMap::updateDrawList()
 	g_profiler->avg("MapBlocks drawn [#]", m_drawlist.size());
 }
 
+void ClientMap::callOverDrawList(const std::function<void(v3s16, MapBlock *)> &cb)
+{
+	for (auto &i : m_drawlist) {
+		cb(i.first, i.second);
+	}
+}
+
 void ClientMap::touchMapBlocks()
 {
 	if (m_control.range_all || m_loops_occlusion_culler)

src/client/clientmap.h

@@ -90,6 +90,7 @@ class ClientMap : public Map, public scene::ISceneNode
 	void getBlocksInViewRange(v3s16 cam_pos_nodes,
 		v3s16 *p_blocks_min, v3s16 *p_blocks_max, float range=-1.0f);
 	void updateDrawList();
+	void callOverDrawList(const std::function<void(v3s16, MapBlock *)> &cb);
 	// @brief Calculate statistics about the map and keep the blocks alive
 	void touchMapBlocks();
 	void updateDrawListShadow(v3f shadow_light_pos, v3f shadow_light_dir, float radius, float length);

src/database/database-files.cpp

@@ -140,7 +140,7 @@ void PlayerDatabaseFiles::savePlayer(RemotePlayer *player)
 	std::string savedir = m_savedir + DIR_DELIM;
 	std::string path = savedir + player->getName();
 	bool path_found = false;
-	RemotePlayer testplayer("", NULL);
+	RemotePlayer testplayer("", NULL, NULL);
 
 	for (u32 i = 0; i < PLAYER_FILE_ALTERNATE_TRIES && !path_found; i++) {
 		if (!fs::PathExists(path)) {
@@ -184,7 +184,7 @@ bool PlayerDatabaseFiles::removePlayer(const std::string &name)
 	std::string players_path = m_savedir + DIR_DELIM;
 	std::string path = players_path + name;
 
-	RemotePlayer temp_player("", NULL);
+	RemotePlayer temp_player("", NULL, NULL);
 	for (u32 i = 0; i < PLAYER_FILE_ALTERNATE_TRIES; i++) {
 		// Open file and deserialize
 		auto is = open_ifstream(path.c_str(), false);
@@ -245,7 +245,7 @@ void PlayerDatabaseFiles::listPlayers(std::vector<std::string> &res)
 		if (!is.good())
 			continue;
 
-		RemotePlayer player(filename.c_str(), NULL);
+		RemotePlayer player(filename.c_str(), NULL, NULL);
 		// Null env & dummy peer_id
 		PlayerSAO playerSAO(NULL, &player, 15789, false);
 

src/mapnode.cpp

@@ -40,7 +40,9 @@ void MapNode::getColor(const ContentFeatures &f, video::SColor *color) const
 
 u16 MapNode::getVariant(const ContentFeatures &f) const
 {
-	return f.variant_count > 1 ? f.param2_variant.get(param2) % f.variant_count : 0;
+	if (f.variant_count > 1)
+		return (f.param2_variant.get(param2) + f.variant_offset) % f.variant_count;
+	return 0;
 }
 
 u8 MapNode::getFaceDir(const NodeDefManager *nodemgr,