feat: Add configurable icons for non-recipe rows.

DaleStan · DaleStan · commit 4db2c39d9a27 · 2025-11-04T16:09:31.000-05:00
diff --git a/Yafc.Model.Tests/Serialization/SerializationTreeChangeDetection.cs b/Yafc.Model.Tests/Serialization/SerializationTreeChangeDetection.cs
@@ -58,6 +58,8 @@ public class SerializationTreeChangeDetection {
         },
         [typeof(RecipeRow)] = new() {
             [nameof(RecipeRow.recipe)] = typeof(IObjectWithQuality<RecipeOrTechnology>),
+            [nameof(RecipeRow.icon)] = typeof(FactorioObject),
+            [nameof(RecipeRow.description)] = typeof(string),
             [nameof(RecipeRow.entity)] = typeof(IObjectWithQuality<EntityCrafter>),
             [nameof(RecipeRow.fuel)] = typeof(IObjectWithQuality<Goods>),
             [nameof(RecipeRow.fixedBuildings)] = typeof(float),
diff --git a/Yafc.Model/Model/ProductionTableContent.cs b/Yafc.Model/Model/ProductionTableContent.cs
@@ -311,6 +311,9 @@ public sealed class RecipeRow : ModelObject<ProductionTable>, IGroupedElement<Pr
     private ModuleTemplate? _modules;
 
     public IObjectWithQuality<RecipeOrTechnology>? recipe { get; }
+    public FactorioObject? icon { get; set; }
+    public string? description { get; set; }
+
     // Variable parameters
     public IObjectWithQuality<EntityCrafter>? entity {
         get => _entity;
diff --git a/Yafc/Data/locale/en/yafc.cfg b/Yafc/Data/locale/en/yafc.cfg
@@ -363,6 +363,8 @@ select-icon=Select icon
 page-settings-icon-hint=And select icon
 page-settings-create-header=Create new page
 page-settings-edit-header=Edit page icon and name
+header-settings-create-header=Create new header
+header-settings-edit-header=Edit icon and name
 create=Create
 ok=OK
 cancel=Cancel
@@ -749,6 +751,7 @@ production-table-header-ingredients=Ingredients
 production-table-header-products=Products
 production-table-header-modules=Modules
 production-table-add-raw-recipe=Add raw recipe
+production-table-add-table-header=Add nested table header
 production-table-add-technology=Add technology
 production-table-export-to-blueprint=Export inputs and outputs to blueprint with constant combinators:
 production-table-export-entities-to-blueprint=Export entities to blueprint
diff --git a/Yafc/Widgets/ImmediateWidgets.cs b/Yafc/Widgets/ImmediateWidgets.cs
@@ -135,7 +135,7 @@ public static Click BuildFactorioObjectButtonBackground(this ImGui gui, Rect rec
 
         var evt = gui.BuildButton(rect, bgColor, overColor, button: 0, drawTransparent: drawTransparent);
 
-        if (evt == ButtonEvent.MouseOver && obj != null) {
+        if (evt == ButtonEvent.MouseOver && obj != null && !tooltipOptions.Hide) {
             MainScreen.Instance.ShowTooltip(obj, gui, rect, tooltipOptions);
         }
         else if (evt == ButtonEvent.Click) {
diff --git a/Yafc/Widgets/ObjectTooltip.cs b/Yafc/Widgets/ObjectTooltip.cs
@@ -741,6 +741,10 @@ public struct ObjectTooltipOptions {
     /// Gets or sets a value that, if not <see langword="null"/>, will be called after drawing the spoilage information.
     /// </summary>
     public GuiBuilder ExtraSpoilInformation { get; set; }
+    /// <summary>
+    /// If <see langword="true"/>, a tooltip will not be shown for this object.
+    /// </summary>
+    public bool Hide { get; set; }
 
     // Reduce boilerplate by permitting unambiguous and relatively obvious implicit conversions.
     public static implicit operator ObjectTooltipOptions(HintLocations hintLocations) => new() { HintLocations = hintLocations };
diff --git a/Yafc/Windows/HeaderRowSettingsPanel.cs b/Yafc/Windows/HeaderRowSettingsPanel.cs
@@ -0,0 +1,73 @@
+﻿using System;
+using Yafc.I18n;
+using Yafc.Model;
+using Yafc.UI;
+
+namespace Yafc;
+
+public class HeaderRowSettingsPanel : PseudoScreen {
+    private readonly RecipeRow? editingRow;
+    private string? description;
+    private FactorioObject? icon;
+    private readonly Action<string?, FactorioObject?>? callback;
+
+    private bool CanSave => !string.IsNullOrEmpty(description) || icon != null;
+
+    private HeaderRowSettingsPanel(RecipeRow? editingRow, Action<string?, FactorioObject?>? callback) {
+        this.editingRow = editingRow;
+        description = editingRow?.description;
+        icon = editingRow?.icon;
+        this.callback = callback;
+    }
+
+    private void Build(ImGui gui, Action<FactorioObject?> setIcon) {
+        _ = gui.BuildTextInput(description, out description, LSs.PageSettingsNameHint, setKeyboardFocus: editingRow == null ? SetKeyboardFocus.OnFirstPanelDraw : SetKeyboardFocus.No);
+        if (gui.BuildFactorioObjectButton(icon, new ButtonDisplayStyle(4f, MilestoneDisplay.None, SchemeColor.Grey) with { UseScaleSetting = false }) == Click.Left) {
+            SelectSingleObjectPanel.Select(Database.objects.all, new(LSs.SelectIcon), setIcon);
+        }
+
+        if (icon == null && gui.isBuilding) {
+            gui.DrawText(gui.lastRect, LSs.PageSettingsIconHint, RectAlignment.Middle);
+        }
+    }
+
+    public static void Show(RecipeRow? row, Action<string?, FactorioObject?>? callback = null) => _ = MainScreen.Instance.ShowPseudoScreen(new HeaderRowSettingsPanel(row, callback));
+
+    public override void Build(ImGui gui) {
+        gui.spacing = 3f;
+        BuildHeader(gui, editingRow == null ? LSs.HeaderSettingsCreateHeader : LSs.HeaderSettingsEditHeader);
+        Build(gui, s => {
+            icon = s;
+            Rebuild();
+        });
+
+        using (gui.EnterRow(0.5f, RectAllocator.RightRow)) {
+            if (editingRow == null && gui.BuildButton(LSs.Create, active: CanSave)) {
+                ReturnPressed();
+            }
+
+            if (editingRow != null && gui.BuildButton(LSs.Ok, active: CanSave)) {
+                ReturnPressed();
+            }
+
+            if (gui.BuildButton(LSs.Cancel, SchemeColor.Grey)) {
+                Close();
+            }
+        }
+    }
+
+    protected override void ReturnPressed() {
+        if (!CanSave) {
+            // Prevent closing with empty information
+            return;
+        }
+        if (editingRow is null) {
+            callback?.Invoke(description, icon);
+        }
+        else if (editingRow.description != description || editingRow.icon != icon) {
+            editingRow.RecordUndo(true).description = description;
+            editingRow.icon = icon;
+        }
+        Close();
+    }
+}
diff --git a/Yafc/Workspace/ProductionTable/ProductionTableView.cs b/Yafc/Workspace/ProductionTable/ProductionTableView.cs
@@ -120,11 +120,18 @@ private static void BuildRowMarker(ImGui gui, RecipeRow row) {
     private class RecipeColumn(ProductionTableView view) : ProductionTableDataColumn(view, LSs.ProductionTableHeaderRecipe, 13f, 13f, 30f, widthStorage: nameof(Preferences.recipeColumnWidth)) {
         public override void BuildElement(ImGui gui, RecipeRow recipe) {
             gui.spacing = 0.5f;
-            switch (gui.BuildFactorioObjectButton(recipe.recipe, ButtonDisplayStyle.ProductionTableUnscaled)) {
-                case Click.Left when recipe.recipe != null:
+            IFactorioObjectWrapper? display = (IFactorioObjectWrapper?)recipe.recipe ?? recipe.icon;
+            ObjectTooltipOptions tooltip = new() { Hide = recipe.recipe == null };
+
+            switch (gui.BuildFactorioObjectButton(display, ButtonDisplayStyle.ProductionTableUnscaled, tooltip)) {
+                case Click.Left:
                     gui.ShowDropDown(delegate (ImGui imgui) {
                         DrawRecipeTagSelect(imgui, recipe);
 
+                        if (recipe.recipe == null && imgui.BuildButton(LSs.EditPageProperties) && imgui.CloseDropdown()) {
+                            HeaderRowSettingsPanel.Show(recipe);
+                        }
+
                         if (recipe.subgroup == null && imgui.BuildButton(LSs.ProductionTableCreateNested) && imgui.CloseDropdown()) {
                             recipe.RecordUndo().subgroup = new ProductionTable(recipe);
                         }
@@ -134,7 +141,7 @@ public override void BuildElement(ImGui gui, RecipeRow recipe) {
                         }
 
                         if (recipe.subgroup != null) {
-                            BuildRecipeButton(imgui, recipe.subgroup);
+                            BuildRecipeButtons(imgui, recipe.subgroup);
                         }
 
                         if (recipe.subgroup != null && imgui.BuildButton(LSs.ProductionTableUnpackNested).WithTooltip(imgui, recipe.subgroup.expanded ? LSs.ProductionTableShortcutRightClick : LSs.ProductionTableShortcutExpandAndRightClick) && imgui.CloseDropdown()) {
@@ -145,15 +152,17 @@ public override void BuildElement(ImGui gui, RecipeRow recipe) {
                             view.BuildShoppingList(recipe);
                         }
 
-                        if (imgui.BuildCheckBox(LSs.ProductionTableShowTotalIo, recipe.showTotalIO, out bool newShowTotalIO)) {
+                        if (recipe.recipe != null && imgui.BuildCheckBox(LSs.ProductionTableShowTotalIo, recipe.showTotalIO, out bool newShowTotalIO)) {
                             recipe.RecordUndo().showTotalIO = newShowTotalIO;
                         }
 
                         if (imgui.BuildCheckBox(LSs.Enabled, recipe.enabled, out bool newEnabled)) {
                             recipe.RecordUndo().enabled = newEnabled;
                         }
 
-                        BuildFavorites(imgui, recipe.recipe.target, LSs.AddRecipeToFavorites);
+                        if (recipe.recipe != null) {
+                            BuildFavorites(imgui, recipe.recipe.target, LSs.AddRecipeToFavorites);
+                        }
 
                         if (recipe.subgroup != null && imgui.BuildRedButton(LSs.ProductionTableDeleteNested).WithTooltip(imgui, recipe.subgroup.expanded ? LSs.ProductionTableShortcutCollapseAndRightClick : LSs.ProductionTableShortcutRightClick) && imgui.CloseDropdown()) {
                             _ = recipe.owner.RecordUndo().recipes.Remove(recipe);
@@ -182,7 +191,7 @@ public override void BuildElement(ImGui gui, RecipeRow recipe) {
                 gui.textColor = recipe.hierarchyEnabled ? SchemeColor.BackgroundText : SchemeColor.BackgroundTextFaint;
             }
 
-            gui.BuildText(recipe.recipe?.target.locName, TextBlockDisplayStyle.WrappedText);
+            gui.BuildText(recipe.recipe?.target.locName ?? recipe.description, recipe.recipe != null || recipe.isOverviewMode ? TextBlockDisplayStyle.WrappedText : TextBlockDisplayStyle.Default());
 
             void unpackNestedTable() {
                 var evacuate = recipe.subgroup.recipes;
@@ -209,7 +218,7 @@ private static void RemoveZeroRecipes(ProductionTable productionTable) {
         }
 
         public override void BuildMenu(ImGui gui) {
-            BuildRecipeButton(gui, view.model);
+            BuildRecipeButtons(gui, view.model);
 
             gui.BuildText(LSs.ProductionTableExportToBlueprint, TextBlockDisplayStyle.WrappedText);
             using (gui.EnterRow()) {
@@ -263,10 +272,10 @@ public override void BuildMenu(ImGui gui) {
         }
 
         /// <summary>
-        /// Build the "Add raw recipe" button and handle its clicks.
+        /// Build the "Add raw recipe" and "Add table header" buttons and handle their clicks.
         /// </summary>
         /// <param name="table">The table that will receive the new recipes or technologies, if any are selected</param>
-        private static void BuildRecipeButton(ImGui gui, ProductionTable table) {
+        private static void BuildRecipeButtons(ImGui gui, ProductionTable table) {
             if (gui.BuildButton(LSs.ProductionTableAddRawRecipe).WithTooltip(gui, LSs.ProductionTableAddTechnologyHint) && gui.CloseDropdown()) {
                 if (InputSystem.Instance.control) {
                     SelectMultiObjectPanel.Select(Database.technologies.all, new(LSs.ProductionTableAddTechnology, Multiple: true,
@@ -279,6 +288,17 @@ private static void BuildRecipeButton(ImGui gui, ProductionTable table) {
                         r => table.AddRecipe(r, DefaultVariantOrdering));
                 }
             }
+
+            if (gui.BuildButton(LSs.ProductionTableAddTableHeader) && gui.CloseDropdown()) {
+                HeaderRowSettingsPanel.Show(null, (description, icon) => {
+                    RecipeRow newRow = new(table, null) {
+                        description = description,
+                        icon = icon,
+                    };
+                    newRow.subgroup = new(newRow);
+                    table.RecordUndo().recipes.Add(newRow);
+                });
+            }
         }
 
         private void ExportIo(float multiplier) {
diff --git a/changelog.txt b/changelog.txt
@@ -21,6 +21,8 @@
 ----------------------------------------------------------------------------------------------------------------------
 Version:
 Date:
+    Features:
+        - Support tables without a header recipe.
     Fixes:
         - Support craft-fluid and scripted research triggers.
         - Consider quality restrictions when analyzing craft-item or build-item technology triggers.

Original file line number	Diff line number	Diff line change
`@@ -135,7 +135,7 @@ public static Click BuildFactorioObjectButtonBackground(this ImGui gui, Rect rec`
`135`	`135`
`136`	`136`	`var evt = gui.BuildButton(rect, bgColor, overColor, button: 0, drawTransparent: drawTransparent);`
`137`	`137`
`138`		`- if (evt == ButtonEvent.MouseOver && obj != null) {`
	`138`	`+ if (evt == ButtonEvent.MouseOver && obj != null && !tooltipOptions.Hide) {`
`139`	`139`	`MainScreen.Instance.ShowTooltip(obj, gui, rect, tooltipOptions);`
`140`	`140`	`}`
`141`	`141`	`else if (evt == ButtonEvent.Click) {`