Factorio Forums

Code: Select all

-- Destroy a gui element if it is valid
local function destroy_if_valid(element)
	if element and element.valid then element.destroy() end
end

-- Print the currently opened gui element name
local function print_opened(player, msg)
	player.print(msg..tostring(player.opened and player.opened.name))
end

-- Print if the player is in spectator mode
local function print_spectator(player, msg)
	player.print(msg..'Spectator? '..tostring(player.controller_type == defines.controllers.spectator))
end

-- Put the player into spectator
local function start_spectate(player)
	local character = player.character
	player.set_controller{ type = defines.controllers.spectator }
	player.associate_character(character)
	-- Add a message to the screen
	print_opened(player, 'Before Spectate: ')
	player.opened = player.gui.center.add{
		name = 'spectate_label',
		type = 'label',
		caption = 'You are in spectator'
	}
	print_opened(player, 'After Spectate: ')
end

-- Take the player out of spectator
local function stop_spectate(player)
	local character = player.get_associated_characters()[1]
	if character and character.valid then
		-- Give the player their original character
		print_opened(player, 'Before Controller Change: ')
		player.teleport(character.position, character.surface)
		player.set_controller{ type = defines.controllers.character, character = character }
		print_opened(player, 'After Controller Change: ')
	else
		-- Respawn the player
		player.ticks_to_respawn = 300
	end
	-- Close the gui if it is present
	destroy_if_valid(player.gui.center.spectate_label)
end

-- Command will toggle spectator while preserving your character
commands.add_command('spectate', 'Toggle spectate', function(event)
	local player = game.get_player(event.player_index)
	if player.controller_type == defines.controllers.spectator then
		player.print('## Left spectator')
		stop_spectate(player)
	else
		player.print('## Entered spectator')
		start_spectate(player)
	end
end)

-- Command will display a message on your screen
commands.add_command('display', 'Display a message on the screen', function(event)
	local player = game.get_player(event.player_index)
	destroy_if_valid(player.gui.center.display_label)
	if not event.parameter then return end
	-- Add the new message if one is given
	player.print('## Display new message')
	print_opened(player, 'Before Display: ')
	print_spectator(player, 'Before Display: ')
	-- player.opened = nil -- Uncomment for work around
	player.opened = player.gui.center.add{
		name = 'display_label',
		type = 'label',
		caption = event.parameter
	}
	print_opened(player, 'After Display: ')
	print_spectator(player, 'After Display: ')
end)

-- Pressing esc will exit spectator and dismiss the display message
script.on_event(defines.events.on_gui_closed, function(event)
	local element = event.element
	if not element or not element.valid then return end
	local player = game.get_player(event.player_index)
	player.print('# Closed: '..element.name)
	print_opened(player, 'During Close '..element.name..': ')

	if element.name == 'spectate_label' then
		-- Handle the spectate label
		stop_spectate(player)
		destroy_if_valid(element)
	elseif element.name == 'display_label' then
		-- Handle the display label
		destroy_if_valid(element)
	end

end)

-- Only used to print events to chat
script.on_event(defines.events.on_gui_opened, function(event)
	local element = event.element
	if not element or not element.valid then return end
	local player = game.get_player(event.player_index)
	player.print('# Opened: '..element.name)
	print_opened(player, 'During Open '..element.name..': ')
end)