Draft copy tool

The copy tool copies a train to a global clipboard.  It copies
the Line number, Routing code, inside text and outside text.
It copies the kinds of wagons in the train and whether they
are flipped around.

Pasting with the copy tool will conditionally flip the train
such that 'your front' of the train, rather than the absolute
front of the train, is what is output. The new train is
oriented to travel forward with the placing player's view.

Conditons are:
- Multi-unit/push-pull train (= has locomotives on both ends):
  Never flipped
- Locomotive-hauled train (= has one end with a locomotive):
  Flipped so that the locomotive is always at the front. If the
  locomotive points long hood forward, it will still point long
  hood forward.
- Rake of wagons (= has no locomotives on ends):
  Flipped according to which end of the train the player copies
  from. If the player is towards the back (wagon out of train
  divded by total wagons > 0.5), then the back becomes the new
  front. If the player is towards the front, no change.

3 files changed, 219 insertions, 0 deletions

diff --git a/advtrains/copytool.lua b/advtrains/copytool.lua
new file mode 100644
index 0000000..93e4c04
--- /dev/null
+++ b/advtrains/copytool.lua
@@ -0,0 +1,218 @@
+--clipboard = {trainlen = number, [n] = {type = string, flipped = bool, }
+
+-- Yaw is in radians. There are 2pi rad in a circle. North is the 0 point and the angle increases anticlockwise.
+-- 4.712389 = 1.5pi; sin(1.5pi) = -1
+-- 7.853981 = 2.5pi; sin(2.5pi) = 1
+
+minetest.register_tool("advtrains:copytool", {
+	description = attrans("Train copy/paste tool\n\nLeft-click: copy train\nRight-click: paste train"),
+	inventory_image = "advtrains_copytool.png",
+	wield_image = "advtrains_copytool.png",
+	stack_max = 1,
+	-- Paste: Take the clipboard and the player yaw, and attempt to place a new train in the world.
+	-- The front of the train is used as the start of the new train and it proceeds backwards from
+	-- the direction of travel.
+	on_place = function(itemstack, placer, pointed_thing)
+			return advtrains.pcall(function()
+				if ((not pointed_thing.type == "node") or (not placer.get_player_name)) then
+					return
+				end
+				local pname = placer:get_player_name()
+
+				local node=minetest.get_node_or_nil(pointed_thing.under)
+				if not node then atprint("[advtrains]Ignore at placer position") return itemstack end
+				local nodename=node.name
+				if(not advtrains.is_track_and_drives_on(nodename, {default=true})) then
+					atprint("no track here, not placing.")
+					return itemstack
+				end
+				if not minetest.check_player_privs(placer, {train_operator = true }) then
+					minetest.chat_send_player(pname, "You don't have the train_operator privilege.")
+					return itemstack
+				end
+				if not minetest.check_player_privs(placer, {train_admin = true }) and minetest.is_protected(pointed_thing.under, placer:get_player_name()) then
+					return itemstack
+				end
+				local tconns=advtrains.get_track_connections(node.name, node.param2)
+				local yaw = placer:get_look_horizontal()
+				local plconnid = advtrains.yawToClosestConn(yaw, tconns)
+				
+				local prevpos = advtrains.get_adjacent_rail(pointed_thing.under, tconns, plconnid, {default=true})
+				if not prevpos then
+					minetest.chat_send_player(pname, "The track you are trying to place the wagon on is not long enough!")
+					return
+				end
+				
+				if (advtrains.clipboard == nil or advtrains.clipboard.wagons == nil) then
+					minetest.chat_send_player(pname, "The clipboard is empty.");
+					return
+				end
+				
+				--[[local wid1 = advtrains.create_wagon("advtrains:KuHa_E231", pname)
+				local wid2 = advtrains.create_wagon("advtrains:MoHa_E231", pname)
+				local wid3 = advtrains.create_wagon("advtrains:KuHa_E231", pname)
+				advtrains.wagons[wid3].wagon_flipped = 1--]]
+				local wagons = {}
+				local n = 1
+				for _, wagonProto in pairs(advtrains.clipboard.wagons) do
+					local wagon = advtrains.create_wagon(wagonProto.type, pname)
+					advtrains.wagons[wagon].wagon_flipped = wagonProto.wagon_flipped
+					wagons[n] = wagon
+					n = n + 1
+				end
+				
+				local id=advtrains.create_new_train_at(pointed_thing.under, plconnid, 0, wagons)
+				local train = advtrains.trains[id]
+				train.text_outside = advtrains.clipboard.text_outside
+				train.text_inside = advtrains.clipboard.text_inside
+				train.routingcode = advtrains.clipboard.routingcode
+				train.line = advtrains.clipboard.line
+				
+				--minetest.after(2, function() advtrains.trains[id].tarvelocity = 2 end)
+				
+				if not advtrains.is_creative(pname) then
+					itemstack:take_item()
+				end
+				return itemstack
+				
+			end)
+		end,
+	-- Copy: Take the pointed-at train and put it on the clipboard
+	on_use = function(itemstack, user, pointed_thing)
+		if not user:get_player_name() then return end
+		minetest.chat_send_player(user:get_player_name(), "Copy NYI")
+		minetest.chat_send_player(user:get_player_name(), string.format("%s", pointed_thing))
+		if (pointed_thing.type ~= "object") then return end
+		for k,v in pairs(pointed_thing) do
+			minetest.chat_send_player(user:get_player_name(), string.format("%s = %s", k, v))
+		end
+		minetest.chat_send_player(user:get_player_name(), string.format("%s", pointed_thing.ref:get_pos()))
+		minetest.chat_send_player(user:get_player_name(), string.format("Yaw=%f", pointed_thing.ref:get_yaw()))
+--[[		for k,v in pairs(pos) do
+			minetest.chat_send_player(user:get_player_name(), string.format("%s = %s",k,v))
+		end--]]
+		local le = pointed_thing.ref:get_luaentity()
+		minetest.chat_send_player(user:get_player_name(), "---")
+		if (le == nil) then
+			minetest.chat_send_player(user:get_player_name(), "No such lua entity!")
+			return
+		end
+		for k,v in pairs(le) do
+			minetest.chat_send_player(user:get_player_name(), string.format("%s = %s",k,v))
+		end
+		minetest.chat_send_player(user:get_player_name(), "---")
+		
+		local wagon = advtrains.wagons[le.id]
+		if (not (le.id and advtrains.wagons[le.id])) then
+			minetest.chat_send_player(user:get_player_name(), string.format("No such wagon: %s", le.id))
+			return
+		end
+		
+		for k,v in pairs(wagon) do
+			minetest.chat_send_player(user:get_player_name(), string.format("%s = %s",k,v))
+		end
+		minetest.chat_send_player(user:get_player_name(), "---")
+		
+		local train = advtrains.trains[wagon.train_id]
+		minetest.chat_send_player(user:get_player_name(), string.format("Train = %s", train))
+		if (not train) then
+			minetest.chat_send_player(user:get_player_name(), string.format("No such train: %s", wagon.train_id))
+			return
+		end
+		
+		-- Record the train length. The paste operation should require this much free space.
+		advtrains.clipboard = {
+			trainlen = math.ceil(train.trainlen),
+			text_outside = train.text_outside,
+			text_inside = train.text_inside,
+			routingcode = train.routingcode,
+			line = train.line,
+			wagons = {}
+		}
+		local trainLength = math.ceil(train.trainlen)
+		
+		minetest.chat_send_player(user:get_player_name(), "Train info---")
+		for k,v in pairs (train) do
+			minetest.chat_send_player(user:get_player_name(), string.format("%s = %s", k, v))
+		end
+		minetest.chat_send_player(user:get_player_name(), "---")
+		
+		local n = 1
+		for _, wagonid in pairs(train.trainparts) do
+			minetest.chat_send_player(user:get_player_name(), string.format("%d", wagonid))
+			local wagon = advtrains.wagons[wagonid]
+			advtrains.clipboard.wagons[n] = {
+				wagon_flipped = wagon.wagon_flipped,
+				type = wagon.type
+			}
+			n = n + 1
+		end
+		
+		for k,v in pairs(advtrains.clipboard) do
+			minetest.chat_send_player(user:get_player_name(), string.format("%s = %s", k, v))
+		end
+		for k,v in pairs(advtrains.clipboard.wagons) do
+			minetest.chat_send_player(user:get_player_name(), string.format("%s = %s", k, v))
+			for l,w in pairs(v) do
+				minetest.chat_send_player(user:get_player_name(), string.format("%s = %s", l, w))
+			end
+		end
+		
+		local player_yaw = user:get_look_horizontal()
+		minetest.chat_send_player(user:get_player_name(), string.format("Player yaw = %f", player_yaw))
+		local wagon_yaw = pointed_thing.ref:get_yaw()
+		minetest.chat_send_player(user:get_player_name(), string.format("Wagon yaw = %f", wagon_yaw))
+		
+		-- Decide front of train:
+		-- Locomotive on one end = loco-hauled, that end is front;
+		-- if (advtrains.wagons[train.trainparts[1]].is_locomotive) then -- do nothing, train is already in right order
+		local function flip_clipboard(wagon_clipboard)
+			local flipped = {}
+			local numWagons = #wagon_clipboard
+			for k, v in ipairs(wagon_clipboard) do
+				local otherSide = (numWagons-k)+1
+				flipped[otherSide] = v
+				local wagon = flipped[otherSide]
+				wagon.wagon_flipped = not wagon.wagon_flipped
+			end
+			return flipped
+		end
+
+		local function is_loco(wagon_id)
+			local wagon = advtrains.wagons[wagon_id]
+			if (not wagon) then return false end
+			local wagon_proto = advtrains.wagon_prototypes[wagon.type or wagon.entity_name]
+			if wagon_proto and wagon_proto.is_locomotive then
+				return true
+			end
+			return false
+		end
+
+		--[[minetest.chat_send_player(user:get_player_name(), ":::")
+		for k,v in pairs(backLoco) do
+			minetest.chat_send_player(user:get_player_name(), string.format("%s = %s", k, v))
+		end
+		minetest.chat_send_player(user:get_player_name(), ":::")
+		--]]
+		local numWagons = #train.trainparts
+		local backLoco = train.trainparts[numWagons]
+		backLoco = is_loco(backLoco)
+		local frontLoco = train.trainparts[1]
+		frontLoco = is_loco(frontLoco)
+		minetest.chat_send_player(user:get_player_name(), string.format("///frontLoco = %s", frontLoco))
+		minetest.chat_send_player(user:get_player_name(), string.format("backLoco = %s///", backLoco))
+		if ((backLoco) and (not frontLoco)) then
+			advtrains.clipboard.wagons = flip_clipboard(advtrains.clipboard.wagons)
+			minetest.chat_send_player(user:get_player_name(), "Flipped train: Loco-hauled")
+		end
+		-- locomotives on both ends = train is push-pull / multi-unit, has no front, do nothing
+		-- no locomotives on ends = rake of wagons, front is end closest to where player copied.
+		if ((not frontLoco) and (not backLoco)) then
+
+			if (wagon.pos_in_trainparts / numWagons > 0.5) then -- towards the end of the rain
+				advtrains.clipboard.wagons = flip_clipboard(advtrains.clipboard.wagons)
+				minetest.chat_send_player(user:get_player_name(), "Flipped train: Rake")
+			end
+		end
+	end
+})
\ No newline at end of file
diff --git a/advtrains/init.lua b/advtrains/init.lua
index 34e2e21..99e81ed 100644
--- a/advtrains/init.lua
+++ b/advtrains/init.lua
@@ -197,6 +197,7 @@ dofile(advtrains.modpath.."/path.lua")
 dofile(advtrains.modpath.."/trainlogic.lua")
 dofile(advtrains.modpath.."/trainhud.lua")
 dofile(advtrains.modpath.."/trackplacer.lua")
+dofile(advtrains.modpath.."/copytool.lua")
 dofile(advtrains.modpath.."/tracks.lua")
 dofile(advtrains.modpath.."/occupation.lua")
 dofile(advtrains.modpath.."/atc.lua")
diff --git a/advtrains/textures/advtrains_copytool.png b/advtrains/textures/advtrains_copytool.png
new file mode 100644
index 0000000..a8ea557
--- /dev/null
+++ b/advtrains/textures/advtrains_copytool.png