Merge branch 'dev'

Author: theRustyKnife

changelog.lua

@@ -1,4 +1,26 @@
 return {
+	{
+		name = "2.0.0",
+		date = "1. 2. 2018",
+		Features = {
+			{
+				"Added an option to automatically sort containers when opened",
+				more = {["5a5f1b0dadcc441024d76d79"] = "https://mods.factorio.com/mod/manual-inventory-sort/discussion/5a5f1b0dadcc441024d76d79"},
+			},
+			{
+				"Added an option to automatically sort player's inventory when opened",
+			},
+		},
+		Changes = {
+			{
+				"Used the new API features to replace the old sorting mechanism",
+				more = {["0.16.21"] = "https://forums.factorio.com/viewtopic.php?f=3&t=57372#p339957"},
+			},
+			"Autosort is now much faster and sorts on each inventory change",
+			"Settings have been moved to the mod options (autosort is only togglable via the hotkey)",
+			"Removed part inventory sorting as it's not possible with the new system",
+		},
+	},
 	{
 		name = "1.8.1",
 		date = "16. 12. 2017",

manual-inventory-sort/changelog.txt

@@ -1,15 +1,26 @@
 ---------------------------------------------------------------------------------------------------
+Version: 2.0.0
+Date: 1. 2. 2018
+  Features:
+    - Added an option to automatically sort containers when opened (https://mods.factorio.com/mod/manual-inventory-sort/discussion/5a5f1b0dadcc441024d76d79)
+    - Added an option to automatically sort player's inventory when opened
+  Changes:
+    - Used the new API features to replace the old sorting mechanism (https://forums.factorio.com/viewtopic.php?f=3&t=57372#p339957)
+    - Autosort is now much faster and sorts on each inventory change
+    - Settings have been moved to the mod options (autosort is only togglable via the hotkey)
+    - Removed part inventory sorting as it's not possible with the new system
+---------------------------------------------------------------------------------------------------
 Version: 1.8.1
 Date: 16. 12. 2017
   Bugfixes:
     - Fixed filters in the main inventory weren't taken into account
 ---------------------------------------------------------------------------------------------------
 Version: 1.8.0
 Date: 16. 12. 2017
-  Changes:
-    - Updated for 0.16
   Bugfixes:
     - Fixed that opened blueprint books and similar items would close when the inventory was sorted (https://github.com/theRustyKnife/ManualInventorySorting/issues/4)
+  Changes:
+    - Updated for 0.16
 ---------------------------------------------------------------------------------------------------
 Version: 1.7.0
 Date: 15. 07. 2017
@@ -61,11 +72,11 @@ Date: 19. 09. 2016
 ---------------------------------------------------------------------------------------------------
 Version: 1.4.5
 Date: 06. 09. 2016
+  Bugfixes:
+    - Fixed GUI buttons would not appear when opened a logistic chest
   Features:
     - Added car and wagon sorting
     - Added Russian translation (by Apriori)
-  Bugfixes:
-    - Fixed GUI buttons would not appear when opened a logistic chest
 ---------------------------------------------------------------------------------------------------
 Version: 1.4.4
 Date: 26. 08. 2016
@@ -89,10 +100,10 @@ Date: 30. 07. 2016
 ---------------------------------------------------------------------------------------------------
 Version: 1.4.0
 Date: 30. 07. 2016
-  Features:
-    - Added sorting GUI
   Bugfixes:
     - Fixed broken migration script (hopefully), apologies to anyone who had problems with this - it should be safe now to migrate from any version to 1.4
+  Features:
+    - Added sorting GUI
 ---------------------------------------------------------------------------------------------------
 Version: 1.3.0
 Date: 30. 07. 2016
@@ -119,10 +130,10 @@ Date: 28. 07. 2016
 ---------------------------------------------------------------------------------------------------
 Version: 1.1.0
 Date: 27. 07. 2016
-  Features:
-    - Added the auto-sort feature. It has performance problems to be solved though.
   Bugfixes:
     - Fixed a bug making it possible to duplicate items with durability in certain cases
+  Features:
+    - Added the auto-sort feature. It has performance problems to be solved though.
 ---------------------------------------------------------------------------------------------------
 Version: 1.0.1
 Date: 27. 07. 2016

manual-inventory-sort/control.lua

@@ -1,6 +1,95 @@
-migration = require "script.migration"
+--TODO: Autosort containers while open?
+--TODO: Stop autosort while open?
+--TODO: Autosort state indicator?
 
-script.on_configuration_changed(migration.migrate)
-script.on_init(migration.init)
 
-require("script.events")
+local SORTABLE = {
+	['container'] = true,
+	['logistic-container'] = true,
+	['car'] = true,
+	['cargo-wagon'] = true,
+}
+
+
+local function init()
+	global.auto_sort = global.auto_sort or {}
+end
+
+
+local function sort_player(index)
+	game.players[index].get_main_inventory().sort_and_merge()
+end
+
+local function sort_opened(index)
+	local player = game.players[index]
+	if player.opened and SORTABLE[player.opened.type] then
+		(
+			player.opened.get_inventory(defines.inventory.car_trunk) or
+			player.opened.get_inventory(defines.inventory.chest) or
+			player.opened.get_inventory(defines.inventory.cargo_wagon)
+		).sort_and_merge()
+	end
+end
+
+
+local function sort_buttons_gui(index)
+	local player = game.players[index]
+	if player.opened or player.opened_self then
+		if not player.gui.left['manual-inventory-sort-buttons'] then
+			local frame = player.gui.left.add{
+				type='frame',
+				name='manual-inventory-sort-buttons',
+				direction='vertical',
+				caption={'manual-inventory-gui-sort-title'},
+			}
+			frame.add{type='button', name='manual-inventory-sort-player', caption={'manual-inventory-gui-sort_player'}}
+			if player.opened and SORTABLE[player.opened.type] then
+				frame.add{type='button', name='manual-inventory-sort-opened', caption={'manual-inventory-gui-sort_chest'}}
+			end
+		end
+	elseif player.gui.left['manual-inventory-sort-buttons'] then
+		player.gui.left['manual-inventory-sort-buttons'].destroy()
+	end
+end
+
+
+script.on_init(init)
+script.on_configuration_changed(init) --TODO: Empty the global table if migrating from an older version
+
+
+script.on_event('manual-inventory-sort', function(event) sort_player(event.player_index); end)
+
+script.on_event('manual-inventory-sort-opened', function(event) sort_opened(event.player_index); end)
+
+script.on_event('manual-inventory-auto-sort-toggle', function(event)
+	local player = game.players[event.player_index]
+	global.auto_sort[player.index] = not global.auto_sort[player.index]
+	if global.auto_sort[player.index] then
+		player.print{"manual-inventory-auto-sort-on"}
+		sort_player(player.index)
+	else player.print{"manual-inventory-auto-sort-off"}; end
+end)
+
+
+script.on_event(defines.events.on_player_main_inventory_changed, function(event)
+	if global.auto_sort[event.player_index] then sort_player(event.player_index); end
+end)
+
+
+script.on_event(defines.events.on_gui_opened, function(event)
+	local player = game.players[event.player_index]
+	local options = settings.get_player_settings(player)
+	
+	if options['manual-inventory-sort-buttons'].value then sort_buttons_gui(player.index); end
+	if options['manual-inventory-sort-on-open'].value then sort_opened(player.index); end
+	if options['manual-inventory-sort-self-on-open'].value then sort_player(player.index); end
+end)
+script.on_event(defines.events.on_gui_closed, function(event) sort_buttons_gui(event.player_index); end)
+
+script.on_event(defines.events.on_gui_click, function(event)
+	if event.element.name == 'manual-inventory-sort-player' then
+		sort_player(event.player_index)
+	elseif event.element.name == 'manual-inventory-sort-opened' then
+		sort_opened(event.player_index)
+	end
+end)

manual-inventory-sort/data-updates.lua

@@ -1,54 +1,20 @@
-data:extend({
+data:extend{
 	{
-		type = "custom-input",
-		name = "manual-inventory-sort",
-		key_sequence = "SHIFT + Q",
-		consuming = "all"
+		type = 'custom-input',
+		name = 'manual-inventory-sort',
+		key_sequence = 'SHIFT + Q',
+		consuming = 'all',
 	},
 	{
-		type = "custom-input",
-		name = "manual-inventory-sort-opened",
-		key_sequence = "CONTROL + Q",
-		consuming = "all"
+		type = 'custom-input',
+		name = 'manual-inventory-sort-opened',
+		key_sequence = 'CONTROL + Q',
+		consuming = 'all',
 	},
 	{
-		type = "custom-input",
-		name = "manual-inventory-auto-sort-toggle",
-		key_sequence = "SHIFT + Y",
-		consuming = "all"
-	},
-	{
-		type = "custom-input",
-		name = "manual-inventory-options",
-		key_sequence = "SHIFT + X",
-		consuming = "all"
-	},
-	{
-		type = "container",
-		name = "manual-inventory-sort-tmp-chest",
-		icon = "__manual-inventory-sort__/graphics/trans.png",
-		icon_size = 32,
-		flags = {"placeable-neutral", "placeable-off-grid"},
-		max_health = 10000,
-		selectable_in_game = false,
-		corpse = "small-remnants",
-		collision_mask = {},
-		collision_box = {{0, 0}, {0, 0}},
-		selection_box = {{-0.5, -0.5}, {0.5, 0.5}},
-		inventory_size = 1000,
-		order = "none",
-		open_sound = { filename = "__base__/sound/wooden-chest-open.ogg" },
-		close_sound = { filename = "__base__/sound/wooden-chest-close.ogg" },
-		vehicle_impact_sound =  { filename = "__base__/sound/car-wood-impact.ogg", volume = 1.0 },
-		picture =
-		{
-			filename = "__manual-inventory-sort__/graphics/trans.png",
-			priority = "extra-high",
-			width = 0,
-			height = 0
-		},
-		circuit_wire_connection_point = circuit_connector_definitions["chest"].points,
-		circuit_connector_sprites = circuit_connector_definitions["chest"].sprites,
-		circuit_wire_max_distance = 0
-	},
-})
+		type = 'custom-input',
+		name = 'manual-inventory-auto-sort-toggle',
+		key_sequence = 'SHIFT + Y',
+		consuming = 'all',
+	}
+}

manual-inventory-sort/data.lua

@@ -1,12 +1,11 @@
 {
 	"name": "manual-inventory-sort",
-	"version": "1.8.1",
+	"version": "2.0.0",
 	"factorio_version": "0.16",
 	"title": "Manual Inventory Sorting",
+	"description": "Makes some tweaks to the way inventory sorting works.\nYou can sort your inventory on demand or toggle auto-sort. Auto-sort can be configured to work for just a part of your inventory. \nIt's also possible to sort chests, cars and cargo wagons.",
 	"author": "TheRustyKnife",
 	"contact": "[email protected]",
-	"description": "Makes some tweaks to the way inventory sorting works.\nYou can sort your inventory on demand or toggle auto-sort. Auto-sort can be configured to work for just a part of your inventory. \nIt's also possible to sort chests, cars and cargo wagons.",
-	"homepage": "http://mods.factorio.com/mods/theRustyKnife/manual-inventory-sort",
-	"date": "2017-12-16",
-	"dependencies": ["base"]
+	"homepage": "https://mods.factorio.com/mod/manual-inventory-sort",
+	"dependencies": ["base >= 0.16.21"]
 }