feat(cmd_blueprint): add filtering for unbuildable blueprints

luaui/Widgets/Tests/cmd_blueprint/test_cmd_blueprint_filter.lua

@@ -0,0 +1,109 @@
+local widgetName = "Blueprint"
+
+function skip()
+	return Spring.GetGameFrame() <= 0
+end
+
+function setup()
+	assert(widgetHandler.knownWidgets[widgetName] ~= nil)
+
+	Test.clearMap()
+
+	initialWidgetActive = widgetHandler.knownWidgets[widgetName].active
+	if initialWidgetActive then
+		widgetHandler:DisableWidget(widgetName)
+	end
+	widgetHandler:EnableWidget(widgetName, true)
+
+	initialCameraState = Spring.GetCameraState()
+
+	Spring.SetCameraState({
+		mode = 5,
+	})
+end
+
+function cleanup()
+	Test.clearMap()
+
+	widgetHandler:DisableWidget(widgetName)
+	if initialWidgetActive then
+		widgetHandler:EnableWidget(widgetName, false)
+	end
+
+	Spring.SetCameraState(initialCameraState)
+end
+
+local delay = 5
+function test()
+	VFS.Include("luarules/configs/customcmds.h.lua")
+
+	widget = widgetHandler:FindWidget(widgetName)
+	assert(widget)
+
+	mock_saveBlueprintsToFile = Test.mock(widget, "saveBlueprintsToFile")
+
+	-- load test blueprints
+	widget.BLUEPRINT_FILE_PATH = "LuaUI/Widgets/Tests/cmd_blueprint/test_cmd_blueprint_filter_blueprints.json"
+	widget.loadBlueprintsFromFile()
+
+	Test.clearMap()
+
+	local builderUnitDefName = "armck"
+
+	local myTeamID = Spring.GetMyTeamID()
+	local x, z = Game.mapSizeX / 2, Game.mapSizeZ / 2
+	local y = Spring.GetGroundHeight(x, z)
+	local facing = 1
+
+	local builderUnitID = SyncedRun(function(locals)
+		return Spring.CreateUnit(
+			locals.builderUnitDefName,
+			locals.x,
+			locals.y,
+			locals.z,
+			locals.facing,
+			locals.myTeamID
+		)
+	end)
+
+	Spring.SelectUnit(builderUnitID)
+
+	Test.waitFrames(delay)
+
+	Spring.SetActiveCommand(
+		Spring.GetCmdDescIndex(CMD_BLUEPRINT_PLACE),
+		1,
+		true,
+		false,
+		false,
+		false,
+		false,
+		false
+	)
+
+	Test.waitFrames(delay)
+
+	assert(widget.blueprintPlacementActive)
+
+	-- make sure we skipped the blueprint #1, which is invalid
+	assert(widget.selectedBlueprintIndex == 2, widget.selectedBlueprintIndex)
+
+	-- make sure we skipped blueprint #3, which is cortex and unbuildable by armada
+	widget.handleBlueprintNextAction()
+	assert(widget.selectedBlueprintIndex == 4, widget.selectedBlueprintIndex)
+
+	-- make sure we rotate to the next valid blueprint, #2
+	widget.handleBlueprintDeleteAction()
+	assert(widget.selectedBlueprintIndex == 2, widget.selectedBlueprintIndex)
+
+	-- reset blueprints
+	widget.loadBlueprintsFromFile()
+
+	-- make sure we rotate to the next valid blueprint, #3 (which shifted from #4)
+	widget.handleBlueprintDeleteAction()
+	assert(widget.selectedBlueprintIndex == 3, widget.selectedBlueprintIndex)
+
+	-- make sure we rotate to the next valid blueprint, nil
+	widget.handleBlueprintDeleteAction()
+	assert(widget.selectedBlueprintIndex == nil, widget.selectedBlueprintIndex)
+end

luaui/Widgets/Tests/cmd_blueprint/test_cmd_blueprint_filter_blueprints.json

@@ -0,0 +1,61 @@
+{
+  "savedBlueprints": [
+    {
+      "ordered": true,
+      "name": "",
+      "spacing": 0,
+      "facing": 0,
+      "units": [
+        {
+          "unitName": "INVALID",
+          "facing": 0,
+          "position": [0, 0, 0]
+        }
+      ]
+    },
+    {
+      "ordered": true,
+      "name": "",
+      "spacing": 0,
+      "facing": 0,
+      "units": [
+        {
+          "unitName": "armwin",
+          "facing": 0,
+          "position": [0, 0, 0]
+        }
+      ]
+    },
+    {
+      "ordered": true,
+      "name": "",
+      "spacing": 0,
+      "facing": 0,
+      "units": [
+        {
+          "unitName": "corwin",
+          "facing": 0,
+          "position": [0, 0, 0]
+        }
+      ]
+    },
+    {
+      "ordered": true,
+      "name": "",
+      "spacing": 0,
+      "facing": 0,
+      "units": [
+        {
+          "unitName": "armwin",
+          "facing": 0,
+          "position": [-24, 0, 0]
+        },
+        {
+          "unitName": "corwin",
+          "facing": 0,
+          "position": [24, 0, 0]
+        }
+      ]
+    }
+  ]
+}

luaui/Widgets/Tests/cmd_blueprint/test_cmd_blueprint_line.lua

@@ -44,9 +44,8 @@ function test()
 	widget = widgetHandler:FindWidget(widgetName)
 	assert(widget)
 
-	while #(widget.blueprints) > 0 do
-		widget.deleteBlueprint(1)
-	end
+	widget.blueprints = {}
+	widget.setSelectedBlueprintIndex(nil)
 
 	local blueprintUnitDefName = "armsolar"
 	local builderUnitDefName = "armck"

luaui/Widgets/Tests/cmd_blueprint/test_cmd_blueprint_single.lua

@@ -44,9 +44,8 @@ function test()
 	widget = widgetHandler:FindWidget(widgetName)
 	assert(widget)
 
-	while #(widget.blueprints) > 0 do
-		widget.deleteBlueprint(1)
-	end
+	widget.blueprints = {}
+	widget.setSelectedBlueprintIndex(nil)
 
 	local blueprintUnitDefName = "armsolar"
 	local builderUnitDefName = "armck"

luaui/Widgets/api_blueprint.lua

@@ -724,6 +724,21 @@ local function setActiveBuilders(unitIDs)
 	)
 end
 
+local function getBuildableUnits(blueprint)
+	local buildable = 0
+	local unbuildable = 0
+
+	for _, unit in ipairs(blueprint.units) do
+		if activeBuilderBuildOptions[unit.unitDefID] then
+			buildable = buildable + 1
+		else
+			unbuildable = unbuildable + 1
+		end
+	end
+
+	return buildable, unbuildable
+end
+
 function widget:Initialize()
 	if not gl.CreateShader then
 		-- no shader support, so just remove the widget itself, especially for headless
@@ -747,6 +762,7 @@ function widget:Initialize()
 		getBuildingDimensions = getBuildingDimensions,
 		getBlueprintDimensions = getBlueprintDimensions,
 		getUnitsBounds = getUnitsBounds,
+		getBuildableUnits = getBuildableUnits,
 		snapBlueprint = snapBlueprint,
 		BUILD_MODES = BUILD_MODES,
 		SQUARE_SIZE = SQUARE_SIZE,