feat(runtime): add multi-instance support for UI presenters

Author: Miguel Cartier

Editor/UiConfigsEditor.cs

@@ -61,12 +61,14 @@ public abstract class UiConfigsEditor<TSet> : Editor
 
 		private const string UiSetExplanation =
 			"UI Set Configurations\n\n" +
-			"UI Sets group multiple presenters that should be displayed together. " +
+			"UI Sets group multiple presenter instances that should be displayed together. " +
 			"When a set is activated via UiService, all its presenters are loaded and shown simultaneously. " +
-			"Presenters are loaded in the order listed (top to bottom).";
+			"Presenters are loaded in the order listed (top to bottom).\n\n" +
+			"You can add the same UI type multiple times with different instance addresses for multi-instance support.";
 
 		private Dictionary<string, string> _assetPathLookup;
 		private List<string> _uiConfigsAddress;
+		private Dictionary<string, Type> _uiTypesByAddress; // Maps addressable address to Type
 		private UiConfigs _scriptableObject;
 		private SerializedProperty _configsProperty;
 		private SerializedProperty _setsProperty;
@@ -214,12 +216,14 @@ private VisualElement CreateConfigElement()
 			container.style.paddingTop = 2;
 			container.style.paddingBottom = 2;
 
+			// UiPresenter Addressable Address
 			var label = new Label();
 			label.style.flexGrow = 1;
 			label.style.paddingLeft = 5;
 			label.style.unityTextAlign = TextAnchor.MiddleLeft;
 			container.Add(label);
 
+			// Layer field
 			var layerField = new IntegerField();
 			layerField.style.width = 80;
 			layerField.style.marginRight = 5;
@@ -245,14 +249,23 @@ private VisualElement CreateSetPresenterElement()
 			dragHandle.tooltip = "Drag to reorder";
 			container.Add(dragHandle);
 
-			// Dropdown for selecting UI presenter
+			// Dropdown for selecting UI presenter type
 			var dropdown = new DropdownField();
 			dropdown.choices = new List<string>(_uiConfigsAddress ?? new List<string>());
 			dropdown.style.flexGrow = 1;
 			dropdown.style.paddingTop = 3;
 			dropdown.style.paddingBottom = 3;
+			dropdown.name = "ui-type-dropdown";
 			container.Add(dropdown);
 
+			// Instance address field (optional)
+			var instanceField = new TextField();
+			instanceField.style.width = 120;
+			instanceField.style.marginLeft = 5;
+			instanceField.tooltip = "Optional instance address (leave empty for default instance)";
+			instanceField.name = "instance-address-field";
+			container.Add(instanceField);
+			
 			// Delete button
 			var deleteButton = new Button { text = "×" };
 			deleteButton.style.width = 25;
@@ -286,9 +299,9 @@ private VisualElement CreateSetElement(string setName, int setIndex)
 			header.style.marginBottom = 5;
 			setContainer.Add(header);
 
-			// Get the property for this set's UI configs
+			// Get the property for this set's UI entries
 			var setProperty = _setsProperty.GetArrayElementAtIndex(setIndex);
-			var uiConfigsAddressProperty = setProperty.FindPropertyRelative(nameof(UiSetConfigSerializable.UiConfigsAddress));
+			var uiEntriesProperty = setProperty.FindPropertyRelative(nameof(UiSetConfigSerializable.UiEntries));
 
 			// ListView for presenters in this set
 			var presenterListView = new ListView
@@ -301,13 +314,13 @@ private VisualElement CreateSetElement(string setName, int setIndex)
 				fixedItemHeight = 28
 			};
 
-			presenterListView.BindProperty(uiConfigsAddressProperty);
+			presenterListView.BindProperty(uiEntriesProperty);
 
 			presenterListView.makeItem = CreateSetPresenterElement;
-			presenterListView.bindItem = (element, index) => BindSetPresenterElement(element, index, uiConfigsAddressProperty, presenterListView);
+			presenterListView.bindItem = (element, index) => BindSetPresenterElement(element, index, uiEntriesProperty, presenterListView);
 
 			// Register callbacks to save changes when items are added, removed, or reordered
-			presenterListView.itemsAdded += indices => OnPresenterItemsAdded(indices, uiConfigsAddressProperty);
+			presenterListView.itemsAdded += indices => OnPresenterItemsAdded(indices, uiEntriesProperty);
 			presenterListView.itemsRemoved += _ => SaveSetChanges();
 			presenterListView.itemIndexChanged += (_, _) => SaveSetChanges();
 
@@ -316,21 +329,40 @@ private VisualElement CreateSetElement(string setName, int setIndex)
 			return setContainer;
 		}
 
-		private void BindSetPresenterElement(VisualElement element, int index, SerializedProperty uiConfigsAddressProperty, ListView listView)
+		private void BindSetPresenterElement(VisualElement element, int index, SerializedProperty uiEntriesProperty, ListView listView)
 		{
-			if (index >= uiConfigsAddressProperty.arraySize)
+			if (index >= uiEntriesProperty.arraySize)
 				return;
 
-			var dropdown = element.Q<DropdownField>();
-			if (dropdown == null)
+			var dropdown = element.Q<DropdownField>("ui-type-dropdown");
+			var instanceField = element.Q<TextField>("instance-address-field");
+			if (dropdown == null || instanceField == null)
 				return;
 
-			var itemProperty = uiConfigsAddressProperty.GetArrayElementAtIndex(index);
+			var entryProperty = uiEntriesProperty.GetArrayElementAtIndex(index);
+			var typeNameProperty = entryProperty.FindPropertyRelative(nameof(UiSetEntry.UiTypeName));
+			var instanceAddressProperty = entryProperty.FindPropertyRelative(nameof(UiSetEntry.InstanceAddress));
+			
+			// Find the matching address for this type
+			var currentTypeName = typeNameProperty.stringValue;
+			Type currentType = string.IsNullOrEmpty(currentTypeName) ? null : Type.GetType(currentTypeName);
+			
+			// Find the address that matches this type
+			string matchingAddress = null;
+			if (currentType != null && _uiTypesByAddress != null)
+			{
+				foreach (var kvp in _uiTypesByAddress)
+				{
+					if (kvp.Value == currentType)
+					{
+						matchingAddress = kvp.Key;
+						break;
+					}
+				}
+			}
 
-			// Find the index in our address list
-			var currentAddress = itemProperty.stringValue;
-			var selectedIndex = string.IsNullOrEmpty(currentAddress) ? 0 : 
-				_uiConfigsAddress.FindIndex(address => address == currentAddress);
+			var selectedIndex = string.IsNullOrEmpty(matchingAddress) ? 0 : 
+				_uiConfigsAddress.FindIndex(address => address == matchingAddress);
 
 			if (selectedIndex < 0) 
 				selectedIndex = 0;
@@ -339,45 +371,87 @@ private void BindSetPresenterElement(VisualElement element, int index, Serialize
 			{
 				// Unbind to prevent stale property references
 				dropdown.Unbind();
+				instanceField.Unbind();
 
-				// Set the current value
+				// Set the current values
 				dropdown.index = selectedIndex;
+				instanceField.value = instanceAddressProperty.stringValue ?? string.Empty;
 
-				// Register callback to store address when changed
+				// Register callback to store type when changed
 				dropdown.RegisterValueChangedCallback(evt =>
 				{
 					var newIndex = dropdown.index;
 					if (newIndex >= 0 && newIndex < _uiConfigsAddress.Count)
 					{
-						itemProperty.stringValue = _uiConfigsAddress[newIndex];
-						SaveSetChanges();
+						var selectedAddress = _uiConfigsAddress[newIndex];
+						if (_uiTypesByAddress.TryGetValue(selectedAddress, out var selectedType))
+						{
+							typeNameProperty.stringValue = selectedType.AssemblyQualifiedName;
+							SaveSetChanges();
+						}
 					}
 				});
 
+				// Register callback for instance address field
+				instanceField.RegisterValueChangedCallback(evt =>
+				{
+					instanceAddressProperty.stringValue = evt.newValue ?? string.Empty;
+					SaveSetChanges();
+				});
+				
 				// Set initial value if property is empty
-				if (string.IsNullOrEmpty(itemProperty.stringValue) && selectedIndex < _uiConfigsAddress.Count)
+				if (string.IsNullOrEmpty(typeNameProperty.stringValue) && selectedIndex < _uiConfigsAddress.Count)
+				{
+					var address = _uiConfigsAddress[selectedIndex];
+					if (_uiTypesByAddress.TryGetValue(address, out var type))
+					{
+						typeNameProperty.stringValue = type.AssemblyQualifiedName;
+						serializedObject.ApplyModifiedProperties();
+					}
+				}
+			}
+
+			// Setup delete button to remove this item from the set
+			var deleteButton = element.Q<Button>("delete-button");
+			if (deleteButton != null)
+			{
+				// Store the click handler in userData to unregister it later if needed
+				if (deleteButton.userData is EventCallback<ClickEvent> previousCallback)
 				{
-					itemProperty.stringValue = _uiConfigsAddress[selectedIndex];
-					serializedObject.ApplyModifiedProperties();
+					deleteButton.UnregisterCallback(previousCallback);
 				}
+
+				EventCallback<ClickEvent> clickHandler = _ =>
+				{
+					uiEntriesProperty.DeleteArrayElementAtIndex(index);
+					SaveSetChanges();
+				};
+
+				deleteButton.userData = clickHandler;
+				deleteButton.RegisterCallback(clickHandler);
 			}
 		}
 
-		private void OnPresenterItemsAdded(IEnumerable<int> indices, SerializedProperty uiConfigsAddressProperty)
+		private void OnPresenterItemsAdded(IEnumerable<int> indices, SerializedProperty uiEntriesProperty)
 		{
-			if (_uiConfigsAddress == null || _uiConfigsAddress.Count == 0)
+			if (_uiConfigsAddress == null || _uiConfigsAddress.Count == 0 || _uiTypesByAddress == null)
 			{
 				return;
 			}
 
 			var defaultAddress = _uiConfigsAddress[0];
+			Type defaultType = _uiTypesByAddress.TryGetValue(defaultAddress, out var type) ? type : null;
 
 			foreach (var index in indices)
 			{
-				if (index < uiConfigsAddressProperty.arraySize)
+				if (index < uiEntriesProperty.arraySize)
 				{
-					var itemProperty = uiConfigsAddressProperty.GetArrayElementAtIndex(index);
-					itemProperty.stringValue = defaultAddress;
+					var entryProperty = uiEntriesProperty.GetArrayElementAtIndex(index);
+					var typeNameProperty = entryProperty.FindPropertyRelative(nameof(UiSetEntry.UiTypeName));
+					var instanceAddressProperty = entryProperty.FindPropertyRelative(nameof(UiSetEntry.InstanceAddress));
+					
+					typeNameProperty.stringValue = defaultType?.AssemblyQualifiedName ?? string.Empty;
+					instanceAddressProperty.stringValue = string.Empty;
 				}
 			}
 
@@ -437,6 +511,16 @@ private void SyncConfigsWithAddressables()
 			_scriptableObject.Configs = configs;
 			_uiConfigsAddress = uiConfigsAddress;
 			_assetPathLookup = assetPathLookup;
+			
+			// Build Type lookup dictionary
+			_uiTypesByAddress = new Dictionary<string, Type>();
+			foreach (var config in configs)
+			{
+				if (!string.IsNullOrEmpty(config.AddressableAddress) && config.UiType != null)
+				{
+					_uiTypesByAddress[config.AddressableAddress] = config.UiType;
+				}
+			}
 
 			EditorUtility.SetDirty(_scriptableObject);
 			AssetDatabase.SaveAssets();

Runtime/IUiService.cs

@@ -10,24 +10,22 @@ namespace GameLovers.UiService
 {
 	/// <summary>
 	/// This service provides an abstraction layer to interact with the game's UI <seealso cref="UiPresenter"/>
-	/// The Ui Service is organized by layers. The higher the layer the more close is to the camera viewport
+	/// The Ui Service is organized by layers. The higher the layer the more close is to the camera viewport.
+	/// Supports multiple instances of the same UI type through the UiInstanceId system.
 	/// </summary>
 	public interface IUiService
 	{
 		/// <summary>
-		/// Gets a read-only dictionary of the Presenters currently Loaded in memory by the UI service.
+		/// Gets a read-only dictionary of all Presenters currently loaded in memory by the UI service.
+		/// Keys are UiInstanceId which contain both the Type and optional instance name.
 		/// </summary>
-		IReadOnlyDictionary<Type, UiPresenter> LoadedPresenters { get; }
+		IReadOnlyDictionary<UiInstanceId, UiPresenter> LoadedPresenters { get; }
 
 		/// <summary>
-		/// Gets a read-only list of the Presenters currently currently visible and were opened by the UI service.
+		/// Gets a read-only list of all Presenter instances currently visible.
+		/// Each entry is a UiInstanceId containing the Type and instance name.
 		/// </summary>
-		IReadOnlyList<Type> VisiblePresenters { get; }
-
-		/// <summary>
-		/// Gets a read-only dictionary of the layers used by the UI service.
-		/// </summary>
-		IReadOnlyDictionary<int, GameObject> Layers { get; }
+		IReadOnlyList<UiInstanceId> VisiblePresenters { get; }
 
 		/// <summary>
 		/// Gets a read-only dictionary of the containers of UI, called 'Ui Set' maintained by the UI service.

Runtime/UiConfigs.cs

@@ -43,16 +43,17 @@ public List<UiConfig> Configs
 		/// <summary>
 		/// Gets the list of UI set configurations
 		/// </summary>
-		public List<UiSetConfig> Sets => _sets.ConvertAll(element => UiSetConfigSerializable.ToUiSetConfig(element, _configs));
+		public List<UiSetConfig> Sets => _sets.ConvertAll(element => UiSetConfigSerializable.ToUiSetConfig(element));
 
 		/// <summary>
 		/// Sets the new size of this scriptable object <seealso cref="UiSetConfig"/> list.
-		/// The UiConfigSets have the same id value that the index in the list
+		/// The UiConfigSets have the same id value that the index in the list.
+		/// Validates entries against available UI configs.
 		/// </summary>
 		/// <param name="size">The new size of the list</param>
 		public void SetSetsSize(int size)
 		{
-			var validAddresses = new HashSet<string>(_configs.Select(c => c.AddressableAddress));
+			var validTypeNames = new HashSet<string>(_configs.Select(c => c.UiType));
 
 			if (size < _sets.Count)
 			{
@@ -64,12 +65,20 @@ public void SetSetsSize(int size)
 				if (i < _sets.Count)
 				{
 					var set = _sets[i];
-					set.UiConfigsAddress.RemoveAll(address => !validAddresses.Contains(address));
+					
+					// Initialize UiEntries if null
+					if (set.UiEntries == null)
+					{
+						set.UiEntries = new List<UiSetEntry>();
+					}
+					
+					// Remove entries that reference non-existent UI types
+					set.UiEntries.RemoveAll(entry => !validTypeNames.Contains(entry.UiTypeName));
 					_sets[i] = set;
 					continue;
 				}
 
-				_sets.Add(new UiSetConfigSerializable { SetId = i, UiConfigsAddress = new List<string>() });
+				_sets.Add(new UiSetConfigSerializable { SetId = i, UiEntries = new List<UiSetEntry>() });
 			}
 		}