path: root/advtrains/trainhud.lua

--trainhud.lua: holds all the code for train controlling

local T = advtrains.texture

advtrains.hud = {}
advtrains.hhud = {}

minetest.register_on_leaveplayer(function(player)
advtrains.hud[player:get_player_name()] = nil
advtrains.hhud[player:get_player_name()] = nil
end)

local mletter={[1]="F", [-1]="R", [0]="N"}

function advtrains.on_control_change(pc, train, flip)
   	local maxspeed = train.max_speed or 10
	if pc.sneak then
		if pc.up then
			train.tarvelocity = maxspeed
		end
		if pc.down then
			train.tarvelocity = 0
		end
		if pc.left then
			train.tarvelocity = 4
		end
		if pc.right then
			train.tarvelocity = 8
		end
		--[[if pc.jump then
			train.brake = true
			--0: released, 1: brake and pressed, 2: released and brake, 3: pressed and brake
			if not train.brake_hold_state or train.brake_hold_state==0 then
				train.brake_hold_state = 1
			elseif train.brake_hold_state==2 then
				train.brake_hold_state = 3
			end
		elseif train.brake_hold_state==1 then
			train.brake_hold_state = 2
		elseif train.brake_hold_state==3 then
			train.brake = false
			train.brake_hold_state = 0
		end]]
		--shift+use:see wagons.lua
	else
		local act=false
		if pc.jump then
			train.ctrl_user = 1
			act=true
		end
		-- If atc command set, only "Jump" key can clear command. To prevent accidental control.
		if train.tarvelocity or train.atc_command then
			return
		end
		if pc.up then
		   train.ctrl_user=4
		   act=true
		end
		if pc.down then
			if train.velocity>0 then
				if pc.jump then
					train.ctrl_user = 0
				else
					train.ctrl_user = 2
				end
				act=true
			else
				advtrains.invert_train(train.id)
				advtrains.atc.train_reset_command(train)
			end
		end
		if pc.left then
			if train.door_open ~= 0 then
				train.door_open = 0
			else
				train.door_open = -1
			end
		end
		if pc.right then
			if train.door_open ~= 0 then
				train.door_open = 0
			else
				train.door_open = 1
			end
		end
		if not act then
			train.ctrl_user = nil
		end
	end
end
function advtrains.update_driver_hud(pname, train, wdata)
	local inside=train.text_inside or ""
	local ft, ht = advtrains.hud_train_format(train, wdata)
	advtrains.set_trainhud(pname, inside.."\n"..ft, ht)
end
function advtrains.clear_driver_hud(pname)
	advtrains.set_trainhud(pname, "")
end

function advtrains.set_trainhud(name, text, driver)
	local hud = advtrains.hud[name]
	local player=minetest.get_player_by_name(name)
	if not player then
	   return
	end
	local drivertext = driver or ""
	local driverhud = {
		hud_elem_type = "image",
		name = "ADVTRAINS_DRIVER",
		position = {x=0.5, y=1},
		offset = {x=0,y=-170},
		text = drivertext,
		alignment = {x=0,y=-1},
		scale = {x=1,y=1},
	}
	if not hud then
		hud = {}
		advtrains.hud[name] = hud
		hud.id = player:hud_add {
			hud_elem_type = "text",
			name = "ADVTRAINS",
			number = 0xFFFFFF,
			position = {x=0.5, y=1},
			offset = {x=0, y=-300},
			text = text,
			scale = {x=200, y=60},
			alignment = {x=0, y=-1},
		}
		hud.driver = player:hud_add(driverhud)
		hud.oldText = text
		hud.oldDriver = drivertext
	else
		if hud.oldText ~= text then
			player:hud_change(hud.id, "text", text)
			hud.oldText=text
		end
		if hud.driver then
			if hud.oldDriver ~= drivertext then
				player:hud_change(hud.driver, "text", drivertext)
				hud.oldDriver = drivertext
			end
		elseif driver then
			hud.driver = player:hud_add(driverhud)
			hud.oldDriver = drivertext
		end
	end
end

function advtrains.set_help_hud(name, text)
	local hud = advtrains.hhud[name]
	local player=minetest.get_player_by_name(name)
	if not player then
	   return
	end
	if not hud then
		hud = {}
		advtrains.hhud[name] = hud
		hud.id = player:hud_add({
			hud_elem_type = "text",
			name = "ADVTRAINS_HELP",
			number = 0xFFFFFF,
			position = {x=1, y=0.3},
			offset = {x=0, y=0},
			text = text,
			scale = {x=200, y=60},
			alignment = {x=1, y=0},
		})
		hud.oldText=text
		return
	elseif hud.oldText ~= text then
		player:hud_change(hud.id, "text", text)
		hud.oldText=text
	end
end

--train.lever:
--Speed control lever in train, for new train control system.
--[[
Value	Disp	Control	Meaning
0		BB		S+Space	Emergency Brake
1		B		Space	Normal Brake
2		-		S		Roll
3		o		<none>	Stay at speed
4		+		W		Accelerate
]]

function advtrains.hud_train_format(train, wdata)
	if not train then return "","" end
	local sformat = string.format -- this appears to be faster than (...):format
	
	local flip = wdata.wagon_flipped
	local max = train.max_speed or 10
	local res = train.speed_restriction
	local vel = advtrains.abs_ceil(train.velocity)
	local vel_kmh=advtrains.abs_ceil(advtrains.ms_to_kmh(train.velocity))
	
	local tlev=train.lever or 3
	if train.velocity==0 and not train.active_control then tlev=1 end
	if train.hud_lzb_effect_tmr then
		tlev=1
	end
	
	local hud = T.combine(500, 100, "black")
	local st = {}
	if train.debug then st = {train.debug} end
	
	---[[ lever
	hud:add_multicolor_fill_topdown(375, 10, 5, 80, 1, "cyan", 1, "white", 2, "orange", 1, "red")
	hud:add_lever_topdown(345, 10, 30, 80, 16, 6, (4-tlev)/4, "gray", "darkslategray")
	--]]
	---[[ reverser
	hud:add(320, 10, T"advtrains_hud_arrow.png":multiply(flip and "gray" or "cyan"))
	hud:add(320, 80, T"advtrains_hud_arrow.png":transform"FY":multiply(flip and "orange" or "gray"))
	hud:add_lever_topdown(320, 25, 15, 50, 15, 5, flip and 1 or 0, "gray", "darkslategray")
	--]]
	---[[ train/wagon ID
	hud:add(10, 10, T"advtrains_hud_twid.png":verticalframe(2, 0):multiply"gray":resize(10, 10))
	hud:add_smallnum(22, 10, 2, tonumber(train.id) or 0, 6, "gray")
	hud:add(10, 30, T"advtrains_hud_twid.png":verticalframe(2, 1):multiply"gray":resize(10, 10))
	hud:add_smallnum(22, 30, 2, tonumber(wdata.id) or 0, 6, "gray")
	--]]
	---[[ train control/safety indication
	hud:add(73, 10, T"advtrains_hud_shunt.png":multiply(train.is_shunt and "orange" or "darkslategray"))
	hud:add(108, 10, T"advtrains_hud_cpl.png":multiply((train.autocouple or train.atc_wait_autocouple) and "cyan" or "darkslategray"))
	hud:add(143, 10, T"advtrains_hud_ars.png":multiply(train.ars_disable and "darkslategray" or "cyan"))
	hud:add(178, 10, T"advtrains_hud_atc.png":multiply((train.tarvelocity or train.atc_command) and "cyan" or "darkslategray"))
	hud:add(213, 10, T"advtrains_hud_lzb.png":multiply(train.hud_lzb_effect_tmr and "red" or "darkslategray"))
	--]]
	---[[ door
	hud:add(283, 10, T"advtrains_hud_door.png":multiply(train.door_open==-1 and "white" or "darkslategray"))
	hud:add(298, 10, T"advtrains_hud_door.png":multiply(train.door_open==1 and "white" or "darkslategray"):transform"FX")
	--]]
	--[[ speed indicators
	hud:add_segmentbar_leftright(10, 65, 217, 20, 3, 20, max, 20, "darkslategray", 0, vel, "white")
	if res and res > 0 then
		hud:add_fill(7+res*11, 60, 3, 30, "red")
	end
	if train.tarvelocity then
		hud:add(1+train.tarvelocity*11, 85, T"advtrains_hud_arrow.png":transform"FY":multiply"cyan")
	end
	--]]
	local lzbdisp
	local lzb = train.lzb
	local lzbspd
	if lzb and lzb.checkpoints then
		local oc = lzb.checkpoints
		for i = 1, #oc do
			if advtrains.interlocking then
				local udata = oc[i].udata
				if udata and udata.signal_pos then
					local sigd = advtrains.interlocking.db.get_sigd_for_signal(udata.signal_pos)
					if sigd then
						local tcbs = advtrains.interlocking.db.get_tcbs(sigd) or {}
						if tcbs.route_rsn then
							table.insert(st, ("%s: %s"):format(minetest.pos_to_string(sigd.p), tcbs.route_rsn))
						end
					end
				end
			end
			local spd = oc[i].speed
			spd = advtrains.speed.min(spd, train.speed_restriction)
			if spd == -1 then spd = nil end
			local c = not spd and "lime" or (type(spd) == "number" and (spd == 0) and "red" or "orange") or nil
			if c then
				if spd and spd~=0 then
					lzbspd = spd
				end
				local dist = math.floor(((oc[i].index or train.index)-train.index))
				dist = math.max(0, math.min(999, dist))
				lzbdisp = {c = c, d = dist}
				break
			end
		end
	end
	if not lzbdisp then
		lzbdisp = {c = "darkslategray", d = 888}
	end
	hud:add_fill(248, 10, 30, 5, lzbdisp.c)
	hud:add_fill(248, 35, 30, 5, lzbdisp.c)
	hud:add_smallnum(248, 20, 2, lzbdisp.d, 4, lzbdisp.c)

	hud:add_n7seg(390, 10, 100, 80, vel, 2, "red")

	---[[ new speed indication bar
	local dispmax = 100
	local vmax = train.max_speed or 20
	for _, n in ipairs {10, 15, 20, 30, 50, 60} do
		if vmax and train.max_speed <= n then
			dispmax = n
			break
		end
	end
	local vsize = 300/dispmax
	hud:add_fill(10, 60, train.velocity*vsize, 30, "white")

	local vmaxmark = 10+math.floor(vmax*vsize)
	hud:add_fill(vmaxmark, 60, 310-vmaxmark, 30, "darkslategray")

	local largestep = dispmax > 30 and 10 or 5
	local smallstep = dispmax > 30 and 2 or 1
	for i = smallstep, vmax, smallstep do
		local markpos = math.min(9 + i*vsize, vmaxmark-2)
		local marksize = 20
		if i % largestep == 0 then
			marksize = 30

			local numlen = math.floor(math.log10(i)) + 1
			hud:add_smallnum(markpos + 4 - 8*numlen, 45, 2, i, numlen, "gray")
		end
		hud:add_fill(markpos, 60, 2, marksize, "gray")
	end

	if res and res > 0 then
		hud:add_fill(math.min(10+math.max(0, math.floor(res*vsize)-1), vmaxmark-2), 60, 2, 30, "red")
	end

	if train.tarvelocity then
		hud:add_fill(math.min(10+math.max(0, math.floor(train.tarvelocity*vsize)-1), vmaxmark-2), 60, 2, 10, "cyan")
	end

	if lzbspd then
		hud:add_fill(math.min(10+math.max(0, math.floor(lzbspd*vsize)-1), vmaxmark-2), 80, 2, 10, "orange")
	end
	--]]
	
	if res and res == 0 then
		table.insert(st, attrans("OVERRUN RED SIGNAL! Examine situation and reverse train to move again."))
	end
	
	if train.atc_command then
		table.insert(st, ("ATC: %s%s"):format(train.atc_delay and advtrains.abs_ceil(train.atc_delay).."s " or "", train.atc_command or ""))
	end
	
	return table.concat(st,"\n"), tostring(hud)
end

local default_hud = { -- dummy train object to demonstrate the train hud
	max_speed = 15, speed_restriction = 15, velocity = 15, tarvelocity = 12,
	active_control = true, lever = 3, ctrl = {lzb = true}, is_shunt = true,
	door_open = 1, lzb = {checkpoints = {{speed=6, index=125.7}}}, index = 100,
	id = "012345",
}
local default_wagon = { id = "987654" }
local _, texture = advtrains.hud_train_format(default_hud, default_wagon)

local hud_test_cache = {}

local speed_scrollbaroptions = "scrollbaroptions[min=0;max=100;smallstep=1]"
local function hudtest_speed_scrollbar(fs, y, id, label, val)
	table.insert(fs, ("label[0.5,%f;%s]"):format(y, core.formspec_escape(label)))
	table.insert(fs, speed_scrollbaroptions)
	table.insert(fs, ("scrollbar[4,%f;6.5,0.4;horizontal;%s;%d]"):format(y-0.2, core.formspec_escape(id), val))
end

local function show_hud_test(pname)
	local fs = {"formspec_version[2]", "size[11,6.5]"}
	local hud = hud_test_cache[pname] or default_hud

	table.insert(fs, ("checkbox[0.5,0.75;noars;Disable ARS;%s]"):format(hud.ars_disable or "false"))
	table.insert(fs, ("checkbox[4,0.75;shunt;Shunt;%s]"):format(hud.is_shunt or "false"))
	table.insert(fs, ("checkbox[7.5,0.75;ac;Autocouple;%s]"):format(hud.autocuople or "false"))

	hudtest_speed_scrollbar(fs, 1.25, "velocity", ("Speed: %d"):format(hud.velocity), hud.velocity)
	hudtest_speed_scrollbar(fs, 1.75, "vmax", ("Max speed: %d"):format(hud.max_speed), hud.max_speed)
	hudtest_speed_scrollbar(fs, 2.25, "res", hud.speed_restriction and ("Restriction: %d"):format(hud.speed_restriction) or "No speed restriction", hud.speed_restriction or 0)

	local _, tx = advtrains.hud_train_format(hud, default_wagon)
	table.insert(fs, ("image[0.5,4;10,2;%s]"):format(core.formspec_escape(tx)))

	core.show_formspec(pname, "advtrains:hud_dev", table.concat(fs))
end

core.register_on_player_receive_fields(function(player, formname, fields)
	if formname ~= "advtrains:hud_dev" then
		return
	end
	if core.is_yes(fields.quit) or core.is_yes(fields.key_enter) then
		return true
	end

	local pname = player:get_player_name()
	local hud = hud_test_cache[pname]
	if not hud then
		hud = table.copy(default_hud)
		hud_test_cache[pname] = hud
	end

	for fk, tk in pairs {noars = "ars_disable", shunt = "is_shunt", ac = "autocouple"} do
		if fields[fk] then
			hud[tk] = core.is_yes(fields[fk])
		end
	end
	
	for fk, tk in pairs {velocity = "velocity", vmax = "max_speed", res = "speed_restriction"} do
		local event = core.explode_scrollbar_event(fields[fk] or "")
		if event and event.type == "CHG" then
			hud[tk] = event.value
		end
	end
	hud.velocity = math.min(hud.velocity, hud.max_speed)
	if hud.speed_restriction <= 0 then
		hud.speed_restriction = nil
	end

	show_hud_test(pname)
	return true
end)

core.register_node("advtrains:hud_demo",{
	description = "Train HUD demonstration",
	tiles = {texture},
	groups = {cracky = 3, not_in_creative_inventory = 1},
	on_rightclick = function(_, _, clicker)
		if clicker:is_player() then
			show_hud_test(clicker:get_player_name())
		end
	end,
})

core.register_craft {
	output = "advtrains:hud_demo",
	recipe = {
		{"default:paper", "default:paper", "default:paper"},
		{"default:paper", "advtrains:trackworker", "default:paper"},
		{"default:paper", "default:paper", "default:paper"},
	}
}