Fixed config loading; Better collection settings

Author: emyfops

src/main/kotlin/com/lambda/Lambda.kt

@@ -80,7 +80,6 @@ object Lambda : ClientModInitializer {
         .registerTypeAdapter(Optional::class.java, OptionalCodec)
         .registerTypeAdapter(ItemStack::class.java, ItemStackCodec)
         .registerTypeAdapter(Text::class.java, Text.Serializer(DynamicRegistryManager.EMPTY))
-        // We have to add all item sub classes :/. I probably missed some
         .registerTypeAdapter(Item::class.java, ItemCodec)
         .registerTypeAdapter(BlockItem::class.java, ItemCodec)
         .registerTypeAdapter(ArrowItem::class.java, ItemCodec)

src/main/kotlin/com/lambda/config/Configuration.kt

@@ -135,16 +135,18 @@ abstract class Configuration : Jsonable, Loadable {
                 LOG.info(message)
                 info(message)
             }
-            .onFailure {
-                var message: String
+            .onFailure { primaryError ->
+                throw primaryError
+                LOG.error(primaryError)
+
                 runCatching { load(backup) }
                     .onSuccess {
-                        message = "${configName.capitalize()} config loaded from backup"
+                        val message = "${configName.capitalize()} config loaded from backup"
                         LOG.info(message)
                         info(message)
                     }
                     .onFailure { error ->
-                        message = "Failed to load ${configName.capitalize()} config from backup, unrecoverable error"
+                        val message = "Failed to load ${configName.capitalize()} config from backup, unrecoverable error"
                         LOG.error(message, error)
                         logError(message)
                     }

src/main/kotlin/com/lambda/config/settings/collections/BlockCollectionSetting.kt

@@ -17,7 +17,9 @@
 
 package com.lambda.config.settings.collections
 
+import com.google.gson.JsonElement
 import com.google.gson.reflect.TypeToken
+import com.lambda.Lambda.gson
 import com.lambda.config.serializer.BlockCodec
 import com.lambda.gui.dsl.ImGuiBuilder
 import imgui.flag.ImGuiSelectableFlags.DontClosePopups
@@ -68,4 +70,11 @@ class BlockCollectionSetting(
 			}
 		}
 	}
+
+	override fun toJson(): JsonElement = gson.toJsonTree(value, type)
+
+	override fun loadFromJson(serialized: JsonElement) {
+		value = gson.fromJson<Collection<Block>>(serialized, type)
+			.toMutableList()
+	}
 }

src/main/kotlin/com/lambda/config/settings/collections/ClassCollectionSetting.kt

@@ -0,0 +1,78 @@
+/*
+ * Copyright 2025 Lambda
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package com.lambda.config.settings.collections
+
+import com.google.gson.JsonElement
+import com.google.gson.reflect.TypeToken
+import com.lambda.Lambda.gson
+import com.lambda.gui.dsl.ImGuiBuilder
+import imgui.flag.ImGuiSelectableFlags.DontClosePopups
+
+/**
+ * @see [com.lambda.config.settings.collections.CollectionSettings]
+ * @see [com.lambda.config.Configurable]
+ */
+class ClassCollectionSetting<T : Any>(
+	override var name: String,
+	private val immutableCollection: Collection<T>,
+	defaultValue: MutableCollection<T>,
+	description: String,
+	visibility: () -> Boolean,
+) : CollectionSetting<T>(
+	name,
+	immutableCollection,
+	defaultValue,
+	TypeToken.getParameterized(Collection::class.java, Any::class.java).type,
+	description,
+	visibility,
+) {
+	override fun ImGuiBuilder.buildLayout() {
+		combo("##$name", "$name: ${value.size} item(s)") {
+			immutableCollection
+				.forEach {
+					val isSelected = value.contains(it)
+
+					selectable(
+						label = it.className,
+						selected = isSelected,
+						flags = DontClosePopups,
+					) {
+						if (isSelected) value.remove(it)
+						else value.add(it)
+					}
+				}
+		}
+	}
+
+	val Any.className: String get() = this::class.java.name
+		.substringAfter("${this::class.java.packageName}.")
+		.replace('$', '.')
+
+	// When serializing the list to json we do not want to serialize the elements' classes, but their stringified representation.
+	// If we do serialize the classes we'll run into missing type adapters errors by Gson.
+	// This is intended behaviour. If you wish your collection settings to display something else then you must extend this class.
+	override fun toJson(): JsonElement = gson.toJsonTree(value.map { it.className })
+
+	override fun loadFromJson(serialized: JsonElement) {
+		val strList = gson.fromJson<MutableList<String>>(serialized, type)
+			.mapNotNull { str -> immutableCollection.find { it.className == str } }
+			.toMutableList()
+
+		value = strList
+	}
+}

src/main/kotlin/com/lambda/config/settings/collections/CollectionSetting.kt

@@ -18,6 +18,7 @@
 package com.lambda.config.settings.collections
 
 import com.google.gson.JsonElement
+import com.google.gson.reflect.TypeToken
 import com.lambda.Lambda.gson
 import com.lambda.config.AbstractSetting
 import com.lambda.config.SettingEditorDsl
@@ -28,6 +29,13 @@ import imgui.flag.ImGuiSelectableFlags.DontClosePopups
 import java.lang.reflect.Type
 
 /**
+ * This generic collection settings handles all [Comparable] values (i.e not classes) and serialize
+ * their values by calling [Any.toString] and loads them by comparing what's in the [immutableCollection].
+ * This behaviour is by design. If you wish to store collections of non-comparable values you must use [ClassCollectionSetting].
+ *
+ * If you wish to use a different codec or simply display values differently you must create your own
+ * collection setting.
+ *
  * @see [com.lambda.config.Configurable]
  */
 open class CollectionSetting<T : Any>(
@@ -44,6 +52,9 @@ open class CollectionSetting<T : Any>(
     description,
     visibility
 ) {
+    private val strListType =
+        TypeToken.getParameterized(Collection::class.java, String::class.java).type
+
     private val selectListeners = mutableListOf<SafeContext.(T) -> Unit>()
     private val deselectListeners = mutableListOf<SafeContext.(T) -> Unit>()
 
@@ -73,9 +84,15 @@ open class CollectionSetting<T : Any>(
         }
     }
 
+    override fun toJson(): JsonElement =
+        gson.toJsonTree(value.map { it.toString() })
+
     override fun loadFromJson(serialized: JsonElement) {
-        value = gson.fromJson<Collection<T>>(serialized, type)
+        val strList = gson.fromJson<Collection<String>>(serialized, strListType)
+            .mapNotNull { str -> immutableCollection.find { it.toString() == str } }
             .toMutableList()
+
+        value = strList
     }
 
     companion object {

src/main/kotlin/com/lambda/config/settings/collections/EventCollectionSetting.kt

@@ -17,7 +17,9 @@
 
 package com.lambda.config.settings.collections
 
+import com.google.gson.JsonElement
 import com.google.gson.reflect.TypeToken
+import com.lambda.Lambda.gson
 import com.lambda.config.serializer.ItemCodec
 import com.lambda.gui.dsl.ImGuiBuilder
 import imgui.flag.ImGuiSelectableFlags.DontClosePopups
@@ -68,4 +70,11 @@ class ItemCollectionSetting(
 			}
 		}
 	}
+
+	override fun toJson(): JsonElement = gson.toJsonTree(value, type)
+
+	override fun loadFromJson(serialized: JsonElement) {
+		value = gson.fromJson<Collection<Item>>(serialized, type)
+			.toMutableList()
+	}
 }