2024.6

Updates

* Unreal 5.4 fully supported on all platforms
* NativeSDK updated to 2024.6 release
* UI Input Glyphs updated for platform compliance
* `FModioModInfo::Price` and related delegate parameters updated to `FModioUnsigned64` and `uint64` for C++ and BP respectively

Bugfixes

* Fix a crash on filter category switching in the UI

Deprecations

* This will be the last Unreal Plugin release with official Unreal 5.1 support.
* In the 2024.9 release, the UI implementation included in the plugin will be migrating to its own dedicated plugin and repository.

Doc/android.adoc

@@ -1,6 +1,68 @@
 == Android Guide
 
-=== Single Sign-On
+=== Single Sign-On (5.4 onwards)
+
+As of UE5.4, there is better support for obtaining an IdToken for Google Authentication. However there are still some changes that need to be made.
+
+If you are on a Source build, open `Engine\Plugins\Online\OnlineSubsystemGoogle\OnlineSubsystemGoogle.uplugin` and add Android to the `PlatformAllowList` array. If you are on a Launcher build, you can simply copy this plugin from this directory into your projects Plugins directory and make the appropriate change.
+
+==== Configuration
+
+Next, update your AndroidEngine.ini file to contain the following:
+
+[source]
+----
+[OnlineSubsystem]
+DefaultPlatformService=GooglePlay
+NativePlatformService=Google
+
+[OnlineSubsystemGoogle]
+bEnabled=True
+ClientId=your-client-id-here
+ServerClientId=your-server-client-id-here
+
+[OnlineSubsystemGoogle.OnlineIdentityGoogle]
++ScopeFields="email"
++ScopeFields="profile"
++ScopeFields="https://www.googleapis.com/auth/userinfo.email"
++ScopeFields="https://www.googleapis.com/auth/userinfo.profile"
+bRequestIdToken=true
+bRequestOfflineAccess=true
+----
+
+This will ensure that you are using OnlineSubsystemGoogle as the native platform OSS in order to perform SSO.
+
+`bRequestIdToken` will request an IdToken that you can pass to mod.io's authentication service. `bRequestOfflineAccess` will request a server-side token that can be used as an alternative to the IdToken.
+
+Ensure that you replace the ClientId and ServerClientId with your client IDs from Google Cloud Console. The ClientId should be the Android OAuth Credential that you have linked to your title in Google Play Console. ServerClientId should be the Web Application OAuth Credential that you configured.
+
+==== Getting the Token
+
+Once you have configured the above options, you should be able to obtain either an IdToken or ServerAuthCode that you can use with mod.io authentication.
+
+[source,c++]
+----
+const IOnlineSubsystem* OnlineSubsystem = IOnlineSubsystem::GetByPlatform();
+const IOnlineIdentityPtr OnlineIdentity = OnlineSubsystem->GetIdentityInterface();
+
+OnlineIdentity->AddOnLoginCompleteDelegate_Handle(0, NativeLoginComplete);
+OnlineIdentity->Login(0, FOnlineAccountCredentials());
+
+// In the NativeLoginComplete delegate, however you set it up, if it was a successful login, you can then obtain the Server Auth Token as follows:
+FString IdToken, ServerAuthToken;
+
+UserAccount.Get()->GetAuthAttribute(AUTH_ATTR_ID_TOKEN, IdToken);
+UserAccount.Get()->GetAuthAttribute(AUTH_ATTR_AUTHORIZATION_CODE, ServerAuthToken);
+
+// Now perform Auth to the mod.io service
+AuthParams.AuthToken = ServerAuthToken;
+AuthParams.bUserHasAcceptedTerms = true;
+            
+// Alternatively you could set AuthParams.AuthToken = IdToken and use EModioAuthenticationProvider::GoogleIDToken
+ModioSubsystem->AuthenticateUserExternalAsync(AuthParams, EModioAuthenticationProvider::GoogleServerSideToken, FOnErrorOnlyDelegateFast::CreateUObject(this, OnAuthenticationComplete));
+---
+
+=== Single Sign-On (Pre-5.4)
 
 For Unreal Engine versions before 5.4, you need to make some engine-level modifications in order for Android SSO to work. You must be using a source build rather than an engine build.
 
@@ -24,7 +86,7 @@ private String getAuthTokenJsonStr(GoogleSignInAccount acct)
 
 Finally, Open OnlineSubsystemGoogle.uplugin and add Android to the `PlatformAllowList`` array.
 
-=== Configuration
+==== Configuration
 
 Once you have made the above changes, update your AndroidEngine.ini to contain the following:
 
@@ -50,7 +112,7 @@ This will ensure that you are using OnlineSubsystemGoogle as the native platform
 
 Ensure that you replace the ClientId and ServerClientId with your client IDs from Google Cloud Console. The ClientId should be the Android OAuth Credential that you have linked to your title in Google Play Console. ServerClientId should be the Web Application OAuth Credential that you configured.
 
-=== Getting the Token
+==== Getting the Token
 
 Once you have configured the above options, you should be able to obtain a server side token that you can use for auth with mod.io.
 

Source/Modio/Private/Internal/Convert/ModInfo.h

@@ -1,11 +1,11 @@
-/* 
+/*
  *  Copyright (C) 2021 mod.io Pty Ltd. <https://mod.io>
- *  
+ *
  *  This file is part of the mod.io UE4 Plugin.
- *  
- *  Distributed under the MIT License. (See accompanying file LICENSE or 
+ *
+ *  Distributed under the MIT License. (See accompanying file LICENSE or
  *   view online at <https://github.com/modio/modio-ue4/blob/main/LICENSE>)
- *   
+ *
  */
 
 #pragma once
@@ -18,19 +18,20 @@
 #include "Internal/ModioConvert.h"
 #include "ModioSDK.h"
 #include "Types/ModioModInfo.h"
+#include "Types/ModioUnsigned64.h"
 
 template<typename DestValueType, typename SourceValueType, typename... OtherParams>
 TArray<DestValueType> ToUnrealD(const std::vector<SourceValueType, OtherParams...>& OriginalArray)
 {
-    TArray<DestValueType> Result;
+	TArray<DestValueType> Result;
 
-    Result.Reserve(OriginalArray.size());
-    for (const auto& It : OriginalArray)
-    {
-        Result.Emplace(ToUnreal(It));
-    }
+	Result.Reserve(OriginalArray.size());
+	for (const auto& It : OriginalArray)
+	{
+		Result.Emplace(ToUnreal(It));
+	}
 
-    return Result;
+	return Result;
 }
 
 FORCEINLINE FModioModInfo ToUnreal(const Modio::ModInfo& In)
@@ -47,23 +48,23 @@ FORCEINLINE FModioModInfo ToUnreal(const Modio::ModInfo& In)
 	Out.ProfileDateUpdated = ToUnrealDateTime(In.ProfileDateUpdated);
 	Out.ProfileDateLive = ToUnrealDateTime(In.ProfileDateLive);
 	Out.ProfileMaturityOption = ToUnreal<EModioMaturityFlags, Modio::MaturityOption>(In.ProfileMaturityOption);
-	Out.Visibility = (EModioObjectVisibilityFlags)In.Visibility;
+	Out.Visibility = (EModioObjectVisibilityFlags) In.Visibility;
 	Out.Dependencies = In.Dependencies;
 
 	Out.MetadataBlob = FString(In.MetadataBlob.c_str()); // Converting verbatim rather than via TCHAR as ToUnreal does
 
-    if (In.FileInfo.has_value())
-    {
-        Out.FileInfo = ToUnreal(In.FileInfo.value());
-    }
+	if (In.FileInfo.has_value())
+	{
+		Out.FileInfo = ToUnreal(In.FileInfo.value());
+	}
 
-    Out.MetadataKvp = ToUnrealD<FModioMetadata>(In.MetadataKvp);
+	Out.MetadataKvp = ToUnrealD<FModioMetadata>(In.MetadataKvp);
 	Out.Tags = ToUnrealD<FModioModTag>(In.Tags);
 	Out.NumGalleryImages = ToUnreal(In.NumGalleryImages);
 	Out.YoutubeURLs = ToUnreal(In.YoutubeURLs);
 	Out.SketchfabURLs = ToUnreal(In.SketchfabURLs);
 	Out.Stats = ToUnreal(In.Stats);
 	Out.ModStatus = (EModioModServerSideStatus) In.ModStatus;
-	Out.Price = In.Price;
+	Out.Price = FModioUnsigned64(In.Price);
 	return Out;
 }

Source/Modio/Private/ModioSubsystem.cpp

@@ -1301,10 +1301,10 @@ void UModioSubsystem::PurchaseModAsync(FModioModID ModID, uint64_t ExpectedPrice
 	});
 }
 
-void UModioSubsystem::K2_PurchaseModAsync(FModioModID ModID, int ExpectedPrice, FOnPurchaseModDelegate Callback)
+void UModioSubsystem::K2_PurchaseModAsync(FModioModID ModID, FModioUnsigned64 ExpectedPrice, FOnPurchaseModDelegate Callback)
 {
 	PurchaseModAsync(
-		ModID, ExpectedPrice,
+		ModID, ExpectedPrice.Underlying,
 		FOnPurchaseModDelegateFast::CreateLambda(
 								 [Callback](FModioErrorCode ec, TOptional<FModioTransactionRecord> TransactionRecord) {
 							 Callback.ExecuteIfBound(ec, ToBP<FModioOptionalTransactionRecord>(TransactionRecord));

Source/Modio/Public/ModioSubsystem.h

@@ -1657,7 +1657,8 @@ class UModioSubsystem : public UEngineSubsystem
 	 * @requires no-rate-limiting
 	 **/
 	UFUNCTION(BlueprintCallable, DisplayName = "PurchaseModAsync", Category = "mod.io|Monetization")
-	MODIO_API void K2_PurchaseModAsync(FModioModID ModID, int ExpectedPrice, FOnPurchaseModDelegate Callback);
+	MODIO_API void K2_PurchaseModAsync(FModioModID ModID, FModioUnsigned64 ExpectedPrice,
+									   FOnPurchaseModDelegate Callback);
 
 	/**
 	 * @docpublic

Source/Modio/Public/Types/ModioModInfo.h

@@ -15,6 +15,7 @@
 #include "Types/ModioModStats.h"
 #include "Types/ModioModTag.h"
 #include "Types/ModioURLList.h"
+#include "Types/ModioUnsigned64.h"
 #include "Types/ModioUser.h"
 
 #include "ModioModInfo.generated.h"
@@ -25,21 +26,21 @@ namespace Modio
 }
 
 /**
-* Enumeration that represent mature content for the mod to create
-**/
+ * Enumeration that represent mature content for the mod to create
+ **/
 UENUM(BlueprintType, meta = (Bitflags, UseEnumValuesAsMaskValuesInEditor = "true"))
 enum class EModioObjectVisibilityFlags : uint8
 {
 	/** Mod is concealed from users **/
 	Hidden = 0,
-	
+
 	/** Mod is openly available **/
 	Public = 1
 };
 
 /**
-* Enumeration that represent mature content for the mod to create
-**/
+ * Enumeration that represent mature content for the mod to create
+ **/
 UENUM(BlueprintType, meta = (Bitflags, UseEnumValuesAsMaskValuesInEditor = "true"))
 enum class EModioMaturityFlags : uint8
 {
@@ -61,8 +62,8 @@ enum class EModioMaturityFlags : uint8
 ENUM_CLASS_FLAGS(EModioMaturityFlags);
 
 /**
-* Enumeration that represent mod server side status
-**/
+ * Enumeration that represent mod server side status
+ **/
 UENUM(BlueprintType, meta = (Bitflags, UseEnumValuesAsMaskValuesInEditor = "true"))
 enum class EModioModServerSideStatus : uint8
 {
@@ -71,9 +72,9 @@ enum class EModioModServerSideStatus : uint8
 	Deleted = 3
 };
 
-/** 
-* Full mod profile including current release information, media links, and stats 
-**/
+/**
+ * Full mod profile including current release information, media links, and stats
+ **/
 USTRUCT(BlueprintType)
 struct MODIO_API FModioModInfo
 {
@@ -127,16 +128,17 @@ struct MODIO_API FModioModInfo
 	UPROPERTY(BlueprintReadOnly, EditInstanceOnly, Category = "Profile")
 	EModioMaturityFlags ProfileMaturityOption {};
 
-	/** @brief Is the mod marked as visible? 
- 	* @deprecated Use Visibility property instead
-	*/
-	UPROPERTY(meta = (DeprecatedProperty, DeprecationMessage = "Deprecated as of 2023.6 release. Please use the <<Visibility>> instead."))
+	/** @brief Is the mod marked as visible?
+	 * @deprecated Use Visibility property instead
+	 */
+	UPROPERTY(meta = (DeprecatedProperty,
+					  DeprecationMessage = "Deprecated as of 2023.6 release. Please use the <<Visibility>> instead."))
 	bool bVisible_DEPRECATED {};
-	
+
 	/**
-	* @brief Enum parameter to signal the backend if the mod to upload would be publicly visible.  
-    * Default value is Public
-	**/
+	 * @brief Enum parameter to signal the backend if the mod to upload would be publicly visible.
+	 * Default value is Public
+	 **/
 	UPROPERTY(BlueprintReadOnly, EditInstanceOnly, Category = "Profile")
 	EModioObjectVisibilityFlags Visibility {};
 
@@ -145,8 +147,8 @@ struct MODIO_API FModioModInfo
 	bool Dependencies;
 
 	/**
-	* Stored property to the metadata string
-	**/
+	 * Stored property to the metadata string
+	 **/
 	UPROPERTY(BlueprintReadOnly, EditInstanceOnly, Category = "Metadata")
 	FString MetadataBlob;
 
@@ -184,20 +186,20 @@ struct MODIO_API FModioModInfo
 
 	/** @brief Price of this mod */
 	UPROPERTY(BlueprintReadOnly, EditInstanceOnly, Category = "Monetization")
-	int32 Price = 0;
+	FModioUnsigned64 Price = FModioUnsigned64(0);
 
 	friend struct FModioModInfo ToUnreal(const struct Modio::ModInfo& In);
 };
 
 /**
-* Strong type struct to store an optional ModInfo parameter
-**/
+ * Strong type struct to store an optional ModInfo parameter
+ **/
 USTRUCT(BlueprintType)
 struct MODIO_API FModioOptionalModInfo
 {
 	GENERATED_BODY()
 	/**
-	* Stored property to an optional ModInfo
-	**/
+	 * Stored property to an optional ModInfo
+	 **/
 	TOptional<FModioModInfo> Internal;
 };

Source/ModioUI/Private/UI/Foundation/Base/ModioCommonActivatableWidget.cpp

@@ -205,6 +205,16 @@ void UModioCommonActivatableWidget::ListenForInputAction(TObjectPtr<UModioCommon
 
 void UModioCommonActivatableWidget::ClearListeningInputActions()
 {
+	// If we're not on the game thread, we need to defer this to the game thread (since UMG/Slate and the ListeningInputActions array are not thread safe)
+	if (!IsInGameThread())
+	{
+		AsyncTask(ENamedThreads::GameThread, [WeakThis = MakeWeakObjectPtr(this)]()
+		{
+			WeakThis->ClearListeningInputActions();
+		});
+		return;
+	}
+
 	UnbindInputActions();
 	ListeningInputActions.Empty();
 }