factorio-shortcuts/Shortcuts/control.lua

--[[ Copyright (c) 2019 npc_strider
 * For direct use of code or graphics, credit is appreciated and encouraged. See LICENSE.txt for more information.
 * This mod may contain modified code sourced from base/core Factorio
 * 
 * control.lua
 * Scripts for updating armor, toggling artillery pieces, drawing grids and managing toggles and variables.
--]]

require("util")

local function update_armor(event)
	local player = game.players[event.player_index]
	local power_armor = player.get_inventory(defines.inventory.character_armor)
	if power_armor and power_armor ~= nil and power_armor.valid then
		if power_armor[1].valid_for_read then
			if power_armor[1].grid and power_armor[1].grid.valid and power_armor[1].grid.width > 0 then
				global.shortcuts_armor[player.index] = power_armor[1].grid
			else
				table.remove(global.shortcuts_armor,player.index)
			end
		else
			table.remove(global.shortcuts_armor,player.index)
		end
	end
end

local function update_state(event, equipment_type) -- toggles the armor
	update_armor(event)
	local grid = global.shortcuts_armor[game.players[event.player_index].index]
	if grid then
		for _, equipment in pairs(grid.equipment) do
			if equipment.valid and equipment.type == equipment_type then
				local name = equipment.name
				local position = equipment.position
				local energy = equipment.energy
				if not (string.sub(equipment.name,1,9) == "disabled-") then
					if equipment_type ~= "active-defense-equipment" or (equipment_type == "active-defense-equipment" and game.equipment_prototypes["disabled-" .. equipment.name]) then
						grid.take(equipment)
						local new_equipment = grid.put{name="disabled-" .. name, position=position}
						if new_equipment and new_equipment.valid then
							new_equipment.energy = energy
						end
						game.players[event.player_index].set_shortcut_toggled(equipment_type, false)
					end
				elseif (string.sub(equipment.name,1,9) == "disabled-") then
					grid.take(equipment)
					local new_equipment = grid.put{name=(string.sub(name,10,#name)), position=position}
					if new_equipment and new_equipment.valid then
						new_equipment.energy = energy
					end
					game.players[event.player_index].set_shortcut_toggled(equipment_type, true)
				end
			end
		end
	end
end

local function toggle_light(player)
	if player.character then
		if global.shortcuts_light[player.index] == nil then
			global.shortcuts_light[player.index] = true
		end
		if global.shortcuts_light[player.index] == true then
			player.character.disable_flashlight()
			global.shortcuts_light[player.index] = false
			player.set_shortcut_toggled("flashlight-toggle", false)
		elseif global.shortcuts_light[player.index] == false then
			player.character.enable_flashlight()
			global.shortcuts_light[player.index] = true
			player.set_shortcut_toggled("flashlight-toggle", true)
		end
	else
		player.print({"", {"error.error-message-box-title"}, ": ", {"player-doesnt-exist", {"gui.character"}}, " (", {"controller.god"}, "): ", {"entity-name.small-lamp"}, " ", {"gui-mod-info.status-disabled"}})
	end
end
local function toggle_rail(player)
	if global.toggle_rail[player.index] == nil then
		global.toggle_rail[player.index] = false
	end
	if global.toggle_rail[player.index] == true then
		player.game_view_settings.show_rail_block_visualisation = false
		global.toggle_rail[player.index] = false
		player.set_shortcut_toggled("rail-block-visualization-toggle", false)
	elseif global.toggle_rail[player.index] == false then
		player.game_view_settings.show_rail_block_visualisation = true
		global.toggle_rail[player.index] = true
		player.set_shortcut_toggled("rail-block-visualization-toggle", true)
	end
end

local function false_shortcuts(player) -- disables things
	if settings.startup["night-vision-equipment"].value == true then
		player.set_shortcut_available("night-vision-equipment", false)
		player.set_shortcut_toggled("night-vision-equipment", false)
	end
	if settings.startup["active-defense-equipment"].value == true then
		player.set_shortcut_available("active-defense-equipment", false)
		player.set_shortcut_toggled("active-defense-equipment", false)
	end
	if settings.startup["belt-immunity-equipment"].value == true then
		player.set_shortcut_available("belt-immunity-equipment", false)
		player.set_shortcut_toggled("belt-immunity-equipment", false)
	end
end

local function enable_it(player, equipment, grid, type) -- enables things
	if grid.valid and equipment.valid then
		local name = equipment.name
		local position = equipment.position
		local energy = equipment.energy
		player.set_shortcut_available(type, true)
		player.set_shortcut_toggled(type, true)
		if (string.sub(equipment.name,1,9) == "disabled-") then
			grid.take(equipment)
			local new_equipment = grid.put{name=(string.sub(name,10,#name)), position=position}
			if new_equipment and new_equipment.valid then
				new_equipment.energy = energy
			end								
		end
	end
end
local function reset_state(event, toggle) -- verifies placement of equipment and armor switching
	update_armor(event)
	local player = game.players[event.player_index]
	local grid = global.shortcuts_armor[game.players[event.player_index].index]
	if grid and grid.valid then
		local equipment = event.equipment
		if equipment and toggle == 1 then --place
			local type = equipment.type
			if type == "night-vision-equipment" or type == "belt-immunity-equipment" or (type == "active-defense-equipment" and game.equipment_prototypes["disabledinactive-" .. equipment.name] == nil) then
				local setting = settings.startup[type]
				if setting and setting.value then
					for _, equipment in pairs(grid.equipment) do	--	Enable all of a type of equipment, even if only one is placed in the grid.
						if equipment.valid and equipment.type == type then
							enable_it(player, equipment, grid, type)
						end
					end
				end
			end
		elseif equipment and toggle == 2 then --take
			local type = game.equipment_prototypes[equipment].type
			local name = game.equipment_prototypes[equipment].name
			if type == "night-vision-equipment" or type == "belt-immunity-equipment" or type == "active-defense-equipment" then
				local setting = settings.startup[type]
				if setting and setting.value then
					local value = false
					for _, equipment in pairs(grid.equipment) do
						if equipment.type == type and equipment.valid then
							if type ~= "active-defense-equipment" then
								value = true
								break
							elseif type == "active-defense-equipment" and game.equipment_prototypes["disabledinactive-" .. equipment.name] == nil then
								value = true
								break
							end
						end
					end
					if value == false then
						player.set_shortcut_available(type, false)
						player.set_shortcut_toggled(type, false)
					end
				end
			end
		elseif toggle == 0 then --armor place
			false_shortcuts(player)
			for _, equipment in pairs(grid.equipment) do
				local type = equipment.type
				if equipment.valid and type == "night-vision-equipment" or type == "belt-immunity-equipment" or (type == "active-defense-equipment" and game.equipment_prototypes["disabledinactive-" .. equipment.name] == nil) then
					local setting = settings.startup[type]
					if setting and setting.value then
						enable_it(player, equipment, grid, equipment.type)
					end
				end
			end
		end
	else
		false_shortcuts(player)
	end
end

local function artillery_swap(wagon,new_name)
	local shellname = {}
	local shellcount = {}
	local inventory
	if wagon.type == "artillery-wagon" then
		inventory = table.deepcopy(wagon.get_inventory(defines.inventory.artillery_wagon_ammo))
	elseif wagon.type == "artillery-turret" then
		inventory = table.deepcopy(wagon.get_inventory(defines.inventory.artillery_turret_ammo))
	end
	
	for i=1,(#inventory) do
		if inventory[i].valid_for_read then
			shellname[#shellname+1] = inventory[i].name
			shellcount[#shellcount+1] = inventory[i].count
		end
	end
	
	local name = wagon.name
	local surface = wagon.surface.name
	local position = wagon.position
	local direction = wagon.direction
	local force = wagon.force
	local kills = wagon.kills
	local damage = wagon.damage_dealt
	local health = wagon.health
	wagon.destroy()
	local new_wagon = game.surfaces[surface].create_entity{name=new_name, position=position, direction=direction, force=force, create_build_effect_smoke=false}
	if new_wagon then
		new_wagon.kills = kills
		new_wagon.damage_dealt = damage
		new_wagon.health = health
		for i=1,(#shellcount) do
			if new_wagon.can_insert({name=shellname[i],count=shellcount[i]}) == true then
				new_wagon.insert({name=shellname[i],count=shellcount[i]})
			end
		end
	else
		game.print("ERROR: Artillery wagon failed to convert (this is not supposed to occur)")
	end
	return new_wagon
end

local function jam_artillery(event)
	if event.item == "artillery-jammer-tool" and event.entities ~= nil then
		local player = game.players[event.player_index]
		local i = 0
		local j = 0
		for _, wagon in pairs(event.entities) do
			local name = wagon.name
			local type = wagon.type
			if wagon.valid and (type == "artillery-wagon" or type == "artillery-turret") and not (string.sub(name,1,9) == "disabled-") then
				i=i+1
				local new_name = ("disabled-" .. name)
				local new_wagon = artillery_swap(wagon,new_name)
				rendering.draw_sprite{sprite="virtual-signal.signal-disabled", x_scale=1.5, y_scale=1.5, target_offset={0.0,-0.5}, render_layer="entity-info-icon-above", target=new_wagon, surface=new_wagon.surface, forces={new_wagon.force}}
			elseif wagon.valid and (type == "artillery-wagon" or type == "artillery-turret") and (string.sub(name,1,9) == "disabled-") then
				j=j+1
				local new_name = (string.sub(name,10,#name))
				artillery_swap(wagon,new_name)
			end
		end
		if game.is_multiplayer() == true then
			if i ~= 0 and j == 0 then
				player.force.print("Player " .. player.name .. " on surface " .. player.surface.name .. " has disabled " .. i .. " artillery")
			elseif i == 0 and j ~= 0 then
				player.force.print("Player " .. player.name .. " on surface " .. player.surface.name .. " has enabled " .. j .. " artillery")
			elseif i ~= 0 and j ~= 0 then
				player.force.print("Player " .. player.name .. " on surface " .. player.surface.name .. " has enabled " .. j .. " and disabled " .. i .. " artillery")
			end
		end
	end
end

local function draw_grid(player_index)
	local player = game.players[player_index]
	if global.shortcuts_grid[player_index] == nil then
		global.shortcuts_grid[player_index] = {}
	end
	-- game.print(#global.shortcuts_grid[player_index])
	if #global.shortcuts_grid[player_index] == 0 then
		player.set_shortcut_toggled("draw-grid", true)
		-- Opts
		local settings = settings.get_player_settings(player)
		local radius = settings["grid-radius"].value
		local step = settings["grid-step"].value
		local thinn_width = settings["grid-line-width"].value
		local thicc_width = settings["grid-chunk-line-width"].value
		local chunk_align = settings["grid-chunk-align"].value
		local ground_grid = settings["grid-ground"].value
		
		local center_x = math.floor(player.position.x)
		local center_y = math.floor(player.position.y)
		if chunk_align == true then
			center_x = math.floor(player.position.x/32)*32
			center_y = math.floor(player.position.y/32)*32
		end
		-- game.print(center_x .. ", " .. center_y)
		for i=-radius,(radius),step do
			if (center_x+i) % 32 == 0 then
				width = thicc_width
			else
				width = thinn_width
			end
			local line = rendering.draw_line{
				color = {r = 0, g = 0, b = 0, a = 1},
				width = width,
				from = {center_x+i,center_y+radius},
				to = {center_x+i,center_y-radius},
				surface = player.surface,
				players = {player},
				draw_on_ground = ground_grid
			}
			global.shortcuts_grid[player_index][#global.shortcuts_grid[player_index]+1] = line
			
			if (center_y+i) % 32 == 0 then
				width = thicc_width
			else
				width = thinn_width
			end
			local line = rendering.draw_line{
				color = {r = 0, g = 0, b = 0, a = 1},
				width = width,
				from = {center_x+radius,center_y+i},
				to = {center_x-radius,center_y+i},
				-- from = {center_x+radius,center_y+i}, -- 	this looks pretty cool (although not a grid)
				-- to = {center_x-i,center_y+radius},
				surface = player.surface,
				players = {player},
				draw_on_ground = ground_grid
			}
			global.shortcuts_grid[player_index][#global.shortcuts_grid[player_index]+1] = line
		end
	else
		player.set_shortcut_toggled("draw-grid", false)
		local grid = global.shortcuts_grid[player_index]
		for i=1,(#grid) do
			rendering.destroy(grid[i])
			grid[i] = nil
		end
	end
end

local function initialize()
	if global.shortcuts_light == nil then
		global.shortcuts_light = {}
	end
	if global.toggle_rail == nil then
		global.toggle_rail = {}
	end
	if global.shortcuts_armor == nil then
		global.shortcuts_armor = {}
	end
	if global.shortcuts_grid == nil then
		global.shortcuts_grid = {}
	end
end

script.on_event(defines.events.on_player_armor_inventory_changed, function(event)
	if not game.active_mods["Nanobots"] then
		reset_state(event,0)
	end
end)
script.on_event(defines.events.on_player_placed_equipment, function(event)
	if not game.active_mods["Nanobots"] then
		reset_state(event,1)
	end
end)
script.on_event(defines.events.on_player_removed_equipment, function(event)
	if not game.active_mods["Nanobots"] then
		reset_state(event,2)
	end
end)

local function shortcut_type(event)
	local prototype_name = event.prototype_name
	if not game.active_mods["Nanobots"] then
		if prototype_name == "night-vision-equipment" then
			update_state(event, "night-vision-equipment")
			return
		elseif prototype_name == "belt-immunity-equipment" then
			update_state(event, "belt-immunity-equipment")
			return
		elseif prototype_name == "active-defense-equipment" then
			update_state(event, "active-defense-equipment")
			return
		end
	end
	if prototype_name == "big-zoom" then
		local player = game.players[event.player_index]
		if settings.global["disable-zoom"].value == true then
			player.zoom = settings.get_player_settings(player)["zoom-level"].value
		else
			player.print({"", {"error.error-message-box-title"}, ": ", {"controls.alt-zoom-out"}, " ", {"gui-mod-info.status-disabled"}})
		end
	elseif prototype_name == "draw-grid" then
		draw_grid(event.player_index)
	elseif prototype_name == "tree-killer" then
		local player = game.players[event.player_index]
		if player.cursor_stack.valid_for_read == false then
			if player.cursor_stack.can_set_stack({name="shortcuts-deconstruction-planner"}) then
				player.cursor_stack.set_stack({name="shortcuts-deconstruction-planner"})
				player.cursor_stack.trees_and_rocks_only = true
			end
		end
	elseif prototype_name == "flashlight-toggle" then
		toggle_light(game.players[event.player_index])
	elseif prototype_name == "rail-block-visualization-toggle" then
		toggle_rail(game.players[event.player_index])
	elseif prototype_name == "signal-flare" then
		local player = game.players[event.player_index]
		if settings.global["disable-zoom"].value == true then
			player.force.print({"", "[img=virtual-signal.signal-danger] [color=1,0.1,0.1]", {"entity-name.player"}, " " ..  player.name .. " [gps=" .. math.floor(player.position.x+0.5) .. "," .. math.floor(player.position.y+0.5) ..  "][/color] [img=virtual-signal.signal-danger]"})
		else
			player.print({"", {"error.error-message-box-title"}, ": ", {"technology-name.military"}, " ", {"entity-name.beacon"}, " ", {"gui-mod-info.status-disabled"}})
		end
	end
end

script.on_event(defines.events.on_lua_shortcut, shortcut_type)

-- script.on_event(defines.events.on_player_main_inventory_changed, update_inventory)

script.on_event(defines.events.on_player_created, function(event)
	local player = game.players[event.player_index]
	if settings.startup["flashlight-toggle"].value == true then
		player.set_shortcut_toggled("flashlight-toggle", true)
	end
	if settings.startup["rail-block-visualization-toggle"].value == true then
		player.set_shortcut_toggled("rail-block-visualization-toggle", false)
	end
	if not game.active_mods["Nanobots"] then
		if settings.startup["night-vision-equipment"].value == true then
			player.set_shortcut_available("night-vision-equipment", false)
		end
		if settings.startup["active-defense-equipment"].value == true then
			player.set_shortcut_available("active-defense-equipment", false)
		end
		if settings.startup["belt-immunity-equipment"].value == true then
			player.set_shortcut_available("belt-immunity-equipment", false)
		end
	else
		player.print("WARNING: Shortcuts for modular equipment disabled as Nanobots is installed")
		player.print("> Use the Nanobots hotkeys instead: \"Ctrl F1 - F7 Will toggle specific modular armor equipment on or off\"")
	end
end)

script.on_event(defines.events.on_player_selected_area, jam_artillery)

script.on_init(initialize)
script.on_configuration_changed(initialize)
commands.add_command("shortcuts_initialize_variables", "debug: ensure that all global tables are not nil (should not happen in a normal game)", initialize)