Handling AGS Online Feature in Mainmenu for Connection Errors
Last updated on February 27, 2025
When a player is unable to access an AGS online feature from the game's main menu, it is essential to display a clear and informative error message. This helps players understand that the online feature is currently unavailable due to a connection issue, rather than leaving them confused about why it isn’t working.
For example, if a player tries to access features like store, user entitlements or user wallet but encounters a network failure, the game should notify them with a meaningful message like "Unable to connect. Please check your internet connection and try again."
Below are some examples of AGS online features that might be affected in the main menu. Along with that, we'll also provide a sample code snippet to detect connection issues and handle them properly in your game.
Retrieve Store Display information
- Unreal Engine OSS
- Unreal Engine SDK
- Unity
...
auto ABSubsystem = IOnlineSubsystem::Get(ACCELBYTE_SUBSYSTEM);
auto StoreInterface = ABSubsystem->GetStoreV2Interface();
FOnlineStoreV2AccelBytePtr ABStoreInterface = StaticCastSharedPtr<FOnlineStoreV2AccelByte>(StoreInterface);
FString StoreId;
FString ViewId;
FString Region;
constexpr EAccelBytePlatformMapping PlatformMapping = EAccelBytePlatformMapping::NONE;
ABStoreInterface->QueryStorefront("<UserId>", StoreId, ViewId, Region, PlatformMapping,
FOnQueryStorefrontComplete::CreateWeakLambda(this, [](bool bWasSuccessful, const TArray<FString>& ViewIds, const TArray<FString>& SectionIds, const TArray<FUniqueOfferId>& OfferIds, const TArray<FString>& ItemMappingIds, const FString& Error)
{
if (bWasSuccessful)
{
// Do something when the query store display is successful.
}
else
{
// Implement a solution to handle failed request.
}
}
));
...
Currently, if a retreiving in-game store fails, the AGS OSS does not provide details about whether the failure was caused by an HTTP timeout or another issue.
...
FApiClientPtr ApiClient = FMultiRegistry::GetApiClient();
ApiClient->StoreDisplay.GetAllViews("<PublishedStoreId>",
"<DefaultLanguage>",
THandler<TArray<FAccelByteModelsViewInfo>>::CreateLambda([](const TArray<FAccelByteModelsViewInfo>& Result)
{
// Do something when the query store display is successful.
}), FErrorHandler::CreateLambda([](int32 Code, const FString& Message)
{
UE_LOG(LogTemp, Warning, TEXT("Error query store display. Code: %d, Message: %s"), ErrorCode, *ErrorMessage);
if(ErrorCode == static_cast<int32>(ErrorCodes::NetworkError))
{
// Implement a solution to handle HTTP retry timeout.
}
})
);
...
...
AccelByteSDK.GetClientRegistry().GetApi().GetStoreDisplayService();(new LoginPlatformType(PlatformType.Steam), "platformToken", result =>
{
if (!result.IsError)
{
// Do something when the login is successful.
}
else
{
// Implement a solution to handle failed request.
Debug.LogWarning($"Unable to login. Code: {result.Error.Code}, Message: {result.Error.Message}");
if(result.Error.Code.Equals(ErrorCode.NetworkError))
{
// Implement a solution to handle HTTP retry timeout.
}
}
});
...
Query Player's Entitlements
- Unreal Engine OSS
- Unreal Engine SDK
- Unity
...
auto ABSubsystem = IOnlineSubsystem::Get(ACCELBYTE_SUBSYSTEM);
auto EntitlementsInterface = ABSubsystem->GetEntitlementsInterface();
FOnlineEntitlementsAccelBytePtr ABEntitlementsInterface = StaticCastSharedPtr<FOnlineEntitlementsAccelByte>(EntitlementsInterface);
ABEntitlementsInterface->OnQueryEntitlementsCompleteDelegates.AddWeakLambda(this, [this](bool bWasSuccessful, const FUniqueNetId& UserId, const FString& Namespace, const FString& ErrorMessage)
{
if (bWasSuccessful)
{
// Do something when the query user entitlements is successful.
}
else
{
// Implement a solution to handle failed request.
}
});
EntitlementsInterface->QueryEntitlements(UserId, TEXT(""), FPagedQuery());
...
Currently, if a retreiving user entitlements fails, the AGS OSS does not provide details about whether the failure was caused by an HTTP timeout or another issue.
...
FApiClientPtr ApiClient = FMultiRegistry::GetApiClient();
FString EntitlementName = TEXT("<Entitlement>");
FString ItemId = TEXT("<ItemId>");
TArray<FString> Features = { TEXT("<feature1>") };
int Offset = 0;
int Limit = 20;
ApiClient->Entitlement.QueryUserEntitlements(EntitlementName, ItemId, Offset, Limit
, THandler<FAccelByteModelsEntitlementPagingSlicedResult>::CreateLambda([](const FAccelByteModelsEntitlementPagingSlicedResult& Result)
{
// Do something when the query user entitlements is successful.
}), FErrorHandler::CreateLambda([](int32 ErrorCode, const FString& ErrorMessage)
{
UE_LOG(LogTemp, Warning, TEXT("Error query user entitlements. Code: %d, Message: %s"), ErrorCode, *ErrorMessage);
if(ErrorCode == static_cast<int32>(ErrorCodes::NetworkError))
{
// Implement a solution to handle HTTP retry timeout.
}
}), EAccelByteEntitlementClass::NONE, EAccelByteAppType::NONE
);
...
...
AccelByteSDK.GetClientRegistry().GetApi().GetEntitlement().QueryUserEntitlements("", "<ItemId>", 0, 20, result =>
{
if (!result.IsError)
{
// Do something when the query user entitlements is successful.
}
else
{
// Implement a solution to handle failed request.
Debug.LogWarning($"Unable to login. Code: {result.Error.Code}, Message: {result.Error.Message}");
if(result.Error.Code.Equals(ErrorCode.NetworkError))
{
// Implement a solution to handle HTTP retry timeout.
}
}
});
...
Get Player's Wallet Data
- Unreal Engine OSS
- Unreal Engine SDK
- Unity
...
auto ABSubsystem = IOnlineSubsystem::Get(ACCELBYTE_SUBSYSTEM);
auto WalletInterface = ABSubsystem->GetWalletInterface();
WalletInterface->OnGetWalletInfoCompletedDelegates..AddWeakLambda(this, [this](int32 LocalUserNum, bool bWasSuccessful, const FAccelByteModelsWalletInfo& Response, const FString& Error)
{
if (bWasSuccessful)
{
// Do something when the retrieving wallet data is successful.
}
else
{
// Implement a solution to handle failed request.
}
});
WalletInterface->GetWalletInfoByCurrencyCode(0, TEXT("<SampleCurrencyCode>"), true;
...
Currently, if a retreiving user entitlements fails, the AGS OSS does not provide details about whether the failure was caused by an HTTP timeout or another issue.
...
FApiClientPtr ApiClient = FMultiRegistry::GetApiClient();
ApiClient->Wallet.GetWalletInfoByCurrencyCodeV2(TEXT("<SampleCurrencyCode>")
, THandler<FAccelByteModelsWalletInfoResponse>::CreateLambda([](const FAccelByteModelsWalletInfoResponse& Result)
{
// Do something when the retrieving wallet data is successful.
}), FErrorHandler::CreateLambda([](int32 Code, const FString& Message)
{
UE_LOG(LogTemp, Warning, TEXT("Error retrieving wallet data. Code: %d, Message: %s"), ErrorCode, *ErrorMessage);
if(ErrorCode == static_cast<int32>(ErrorCodes::NetworkError))
{
// Implement a solution to handle HTTP retry timeout.
}
})
);
...
...
AccelByteSDK.GetClientRegistry().GetApi().GetGetWalletser().GetWalletInfoByCurrencyCodeV2("<SampleCurrencyCode>", result =>
{
if (!result.IsError)
{
// Do something when the retrieving wallet data is successful.
}
else
{
// Implement a solution to handle failed request.
Debug.LogWarning($"Unable to login. Code: {result.Error.Code}, Message: {result.Error.Message}");
if(result.Error.Code.Equals(ErrorCode.NetworkError))
{
// Implement a solution to handle HTTP retry timeout.
}
}
});
...