Merge pull request #48 from InfectedBytes/FixTryUnlock

Fix try unlock

Author: InfectedBytes

Assets/Plugins/GameJolt/Scripts/API/Constants.cs

@@ -2,7 +2,7 @@
 {
 	public static class Constants
 	{
-		public const string Version = "2.5.6";
+		public const string Version = "2.5.7";
 
 		public const string ApiProtocol = "https://";
 		public const string ApiRoot = "api.gamejolt.com/api/game/";

Assets/Plugins/GameJolt/Scripts/API/GameJoltAPI.cs

@@ -95,17 +95,18 @@ public IEnumerator GetRequest(string url, ResponseFormat format, Action<Response
 			}
 
 			float timeout = Time.time + Settings.Timeout;
-			var request = UnityVersionAbstraction.GetRequest(url, format);
-			request.SendWebRequest();
-			while(!request.isDone) {
-				if(Time.time > timeout) {
-					request.Abort();
-					callback(new Response("Timeout for " + url));
-					yield break;
+			using(var request = UnityVersionAbstraction.GetRequest(url, format)) {
+				request.SendWebRequest();
+				while(!request.isDone) {
+					if(Time.time > timeout) {
+						request.Abort();
+						callback(new Response("Timeout for " + url));
+						yield break;
+					}
+					yield return new WaitForEndOfFrame();
 				}
-				yield return new WaitForEndOfFrame();
+				callback(new Response(request, format));
 			}
-			callback(new Response(request, format));
 		}
 
 		public IEnumerator PostRequest(string url, Dictionary<string, string> payload, ResponseFormat format,
@@ -117,18 +118,19 @@ public IEnumerator PostRequest(string url, Dictionary<string, string> payload, R
 
 			float timeout = Time.time + Settings.Timeout;
 
-			var request = UnityWebRequest.Post(url, payload);
-			request.SendWebRequest();
-			while(!request.isDone) {
-				if(Time.time > timeout) {
-					request.Abort();
-					callback(new Response("Timeout for " + url));
-					yield break;
+			using(var request = UnityWebRequest.Post(url, payload)) {
+				request.SendWebRequest();
+				while(!request.isDone) {
+					if(Time.time > timeout) {
+						request.Abort();
+						callback(new Response("Timeout for " + url));
+						yield break;
+					}
+					yield return new WaitForEndOfFrame();
 				}
-				yield return new WaitForEndOfFrame();
-			}
 
-			callback(new Response(request, format));
+				callback(new Response(request, format));
+			}
 		}
 		#endregion Requests
 

Assets/Plugins/GameJolt/Scripts/API/Trophies.cs

@@ -92,11 +92,17 @@ public static void TryUnlock(Trophy trophy, Action<TryUnlockResult> callback = n
 		/// <param name="trophy">The <see cref="Trophy"/> ID.</param>
 		/// <param name="callback">A callback function accepting a single parameter, an enum indicating success.</param>
 		public static void TryUnlock(int id, Action<TryUnlockResult> callback = null) {
+			// early return in case we already know it's unlocked
+			if(cachedTrophies != null && cachedTrophies.ContainsKey(id) && cachedTrophies[id].Unlocked) {
+				if(callback != null) callback(TryUnlockResult.AlreadyUnlocked);
+				return;
+			}
 			Get(id, trophy => {
 				if(trophy == null) { // something went wrong -> signal failure
 					if(callback != null) callback(TryUnlockResult.Failure);
 				} else if(!trophy.Unlocked) { // not unlocked yet, so unlock it now
 					var unlockCallback = callback == null ? (Action<bool>)null : success => callback(success ? TryUnlockResult.Unlocked : TryUnlockResult.Failure);
+					trophy.Unlocked = true; // already set it as unlocked so if TryUnlock was called multiple times without waiting for a response, we still only show the notification once
 					Unlock(id, unlockCallback);
 				} else if(callback != null) { // already unlocked, so if we have a callback, signal success
 					callback(TryUnlockResult.AlreadyUnlocked);

CHANGELOG.md

@@ -4,6 +4,12 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][Unreleased]
 
+## [2.5.7][v2_5_7] (2021-08-07)
+
+### Fixed
+- `TryUnlock` would still show two notifications if requested faster than the server could reply
+- Get and Post requests were not wrapped in a `using` statement
+
 ## [2.5.6][v2_5_6] (2020-03-06)
 
 ### Fixed
@@ -191,7 +197,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 Initial release
 
-[Unreleased]: https://github.com/InfectedBytes/gj-unity-api/compare/v2.5.6...HEAD
+[Unreleased]: https://github.com/InfectedBytes/gj-unity-api/compare/v2.5.7...HEAD
+[v2_5_7]: https://github.com/InfectedBytes/gj-unity-api/tree/v2.5.7
 [v2_5_6]: https://github.com/InfectedBytes/gj-unity-api/tree/v2.5.6
 [v2_5_5]: https://github.com/InfectedBytes/gj-unity-api/tree/v2.5.5
 [v2_5_4]: https://github.com/InfectedBytes/gj-unity-api/tree/v2.5.4

Documentation/Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "Game Jolt Unity API"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = v2.5.6
+PROJECT_NUMBER         = v2.5.7
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

Documentation/Pages/tutorial.md

@@ -147,7 +147,7 @@ Trophies need a signed in user.
 **Tip:** Trophies can benefit a lot from caching. Don't forget to enable *Use Caching* in the API settings.
 
 ## Unlock
-Unlocking a trophy will automatically show a notification. Future version of the API will allow you to turn this off.
+Unlocking a trophy will automatically show a notification. But note that if yo ucall this multiple times, you will get multiple notifications. See `TryUnlock` if you only want the notification once.
 
 ```
 GameJolt.API.Trophies.Unlock(trophyID, (bool success) => {
@@ -162,6 +162,24 @@ GameJolt.API.Trophies.Unlock(trophyID, (bool success) => {
 });
 ```
 
+### TryUnlock
+Similar to the normal `Unlock`, but this will only show a notification once and it will also tell you if the trophy was already unlocked.
+```
+GameJolt.API.Trophies.TryUnlock(trophyID, (TryUnlockResult result) => {
+	switch(result) {
+		case TryUnlockResult.Unlocked:
+			Debug.Log("You've unlocked the trophy!");
+			break;
+		case TryUnlockResult.AlreadyUnlocked:
+			Debug.Log("The trophy was already unlocked");
+			break;
+		case TryUnlockResult.Failure:
+			Debug.LogError("Something went wrong!");
+			break;
+	}
+});
+```
+
 ## Show
 ### Default UI
 It's as simple as a single line!