Merge pull request #6 from CoderGamester/develop

0.3.0

Author: CoderGamester

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html)
 
+## [0.3.0] - 2020-02-11
+
+- Added new *UiPresenterData* class for the case where the *UiPresenter* needs to be initialized with a default data value
+- Added new *OnInitialize* method that is invoked after the *UiPresenter* is initialized
+
+## [0.2.0] - 2020-01-19
+
 ## [0.2.1] - 2020-02-09
 
 - Added the possibility to open the ui after adding or loading it to the *UiService*

Runtime/UiPresenter.cs

@@ -11,17 +11,17 @@ namespace GameLovers.UiService
 	public abstract class UiPresenter : MonoBehaviour
 	{
 		private IUiService _uiService;
-		
-		/// <summary>
-		/// Sets the UI <paramref name="data"/>
-		/// </summary>
-		public virtual void SetData<T>(T data) where T : struct {}
 
 		/// <summary>
 		/// Refreshes this opened UI
 		/// </summary>
 		public virtual void Refresh() {}
 
+		/// <summary>
+		/// Allows the ui presenter implementation to have extra behaviour when it is initialized
+		/// </summary>
+		protected virtual void OnInitialized() {}
+		
 		/// <summary>
 		/// Allows the ui presenter implementation to have extra behaviour when it is opened
 		/// </summary>
@@ -43,6 +43,7 @@ protected void Close()
 		internal void Init(IUiService uiService)
 		{
 			_uiService = uiService;
+			OnInitialized();
 		}
 
 		internal void InternalOpen()
@@ -57,4 +58,33 @@ internal void InternalClose()
 			OnClosed();
 		}
 	}
+	
+	/// <summary>
+	/// Tags the <see cref="UiPresenter"/> as a <see cref="UiPresenterData{T}"/> to allow definning a specific state when
+	/// opening it via the <see cref="UiService"/>
+	/// </summary>
+	public interface IUiPresenterData {}
+
+	/// <inheritdoc cref="UiPresenter"/>
+	/// <remarks>
+	/// Extends the <see cref="UiPresenter"/> behaviour with defined data of type <typeparamref name="T"/>
+	/// </remarks>
+	public abstract class UiPresenterData<T> : UiPresenter, IUiPresenterData
+		where T : struct
+	{
+		/// <summary>
+		/// The Ui data defined when opened via the <see cref="UiService"/>
+		/// </summary>
+		public T Data { get; protected set; }
+		
+		/// <summary>
+		/// Allows the ui presenter implementation to have extra behaviour when the data defined for the presenter is set
+		/// </summary>
+		protected virtual void OnSetData(T data) {}
+
+		internal void InternalSetData(T data)
+		{
+			Data = data;
+		}
+	}
 }

Runtime/UiService.cs

@@ -34,9 +34,6 @@ public interface IUiService
 		/// Adds the given <paramref name="uiPresenter"/> to the service and to be included inside the given <paramref name="layer"/>.
 		/// If the given <paramref name="openAfter"/> is true, will open the <see cref="UiPresenter"/> after adding it to the service
 		/// </summary>
-		/// <exception cref="NullReferenceException">
-		/// Thrown if the given <paramref name="uiPresenter"/> is null
-		/// </exception>
 		/// <exception cref="ArgumentException">
 		/// Thrown if the service already contains the given <paramref name="uiPresenter"/>
 		/// </exception>
@@ -163,9 +160,14 @@ public interface IUiService
 		/// <remarks>
 		/// It sets the given <paramref name="initialData"/> data BEFORE opening the UI
 		/// </remarks>
-		T OpenUi<T, TData>(TData initialData) where T : UiPresenter where TData : struct;
+		T OpenUi<T, TData>(TData initialData) 
+			where T : class, IUiPresenterData 
+			where TData : struct;
 
 		///<inheritdoc cref="OpenUi(Type)"/>
+		/// <exception cref="ArgumentException">
+		/// Thrown if the the given <paramref name="type"/> is not of inhereting from <see cref="UiPresenterData{T}"/> class
+		/// </exception>
 		/// <remarks>
 		/// It sets the given <paramref name="initialData"/> data BEFORE opening the UI
 		/// </remarks>
@@ -348,11 +350,6 @@ public void AddUi<T>(T uiPresenter, int layer, bool openAfter = false) where T :
 		{
 			var type = uiPresenter.GetType().UnderlyingSystemType;
 
-			if (uiPresenter == null)
-			{
-				throw new NullReferenceException($"The Ui {type} cannot be null");
-			}
-			
 			if (HasUiPresenter(type))
 			{
 				throw new ArgumentException($"The Ui {type} was already added");
@@ -418,7 +415,7 @@ public T RemoveUi<T>(T uiPresenter) where T : UiPresenter
 		/// <inheritdoc />
 		public async Task<T> LoadUiAsync<T>(bool openAfter = false) where T : UiPresenter
 		{
-			UiPresenter uiPresenter = await LoadUiAsync(typeof(T), openAfter);
+			var uiPresenter = await LoadUiAsync(typeof(T), openAfter);
 
 			return uiPresenter as T;
 		}
@@ -509,7 +506,7 @@ public T OpenUi<T>() where T : UiPresenter
 		/// <inheritdoc />
 		public UiPresenter OpenUi(Type type)
 		{
-			UiPresenter ui = GetUi(type);
+			var ui = GetUi(type);
 
 			if (!_visibleUiList.Contains(type))
 			{
@@ -525,15 +522,24 @@ public UiPresenter OpenUi(Type type)
 		}
 
 		/// <inheritdoc />
-		public T OpenUi<T, TData>(TData initialData) where T : UiPresenter where TData : struct
+		public T OpenUi<T, TData>(TData initialData) 
+			where T : class, IUiPresenterData 
+			where TData : struct
 		{
 			return OpenUi(typeof(T), initialData) as T;
 		}
 
 		/// <inheritdoc />
 		public UiPresenter OpenUi<TData>(Type type, TData initialData) where TData : struct
 		{
-			GetUi(type).SetData(initialData);
+			var uiPresenterData = GetUi(type) as UiPresenterData<TData>;
+
+			if (uiPresenterData == null)
+			{
+				throw new ArgumentException($"The UiPresenter {type} is not of a {nameof(UiPresenterData<TData>)}");
+			}
+			
+			uiPresenterData.InternalSetData(initialData);
 
 			return OpenUi(type);
 		}
@@ -547,7 +553,7 @@ public T CloseUi<T>() where T : UiPresenter
 		/// <inheritdoc />
 		public UiPresenter CloseUi(Type type)
 		{
-			UiPresenter ui = GetUi(type);
+			var ui = GetUi(type);
 
 			if (_visibleUiList.Contains(type))
 			{

package.json

@@ -1,7 +1,7 @@
 {
   "name": "com.gamelovers.uiservice",
   "displayName": "UiService",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "unity": "2019.3",
   "description": "This package provides a service to help manage an Unity's, game UI.\nIt allows to open, close, load, unload and request any Ui Configured in the game.\nThe package provides a Ui Set that allows to group a set of Ui Presenters to help load, open and close multiple Uis at the same time.\n\nTo help configure the game's UI you need to create a UiConfigs Scriptable object by:\n- Right Click on the Project View > Create > ScriptableObjects > Configs > UiConfigs",
   "dependencies": {