Unreal Engine 4

This guide explains the tasks to perform after installing Hive SDK.

Setting the auto-rotate screen feature¶

The following settings are required when the screen orientation is set to both landscape and portrait.

Android¶

For Android app builds, if you set the screen orientation to both landscape and portrait, the following code change is required for the auto-rotate screen feature to work properly.

1. Go to /Engine/Build/Android/Java/src/com/epicgames/ue4/GameActivity.java.template.
2. Add the HiveActivity.onConfigurationChanged() API.

   @Override
   public void onConfigurationChanged(Configuration newConfig)
   {
   HiveActivity.onConfigurationChanged(this, newConfig); // Add
   super.onConfigurationChanged(newConfig);
   
   
   // forward the orientation
   boolean bPortrait = newConfig.orientation == Configuration.ORIENTATION_PORTRAIT;
   nativeOnConfigurationChanged(bPortrait);
   }
   

iOS¶

For bidirectional screen rotation to work properly on iOS, implement the screen rotation-related method application(\_:supportedInterfaceOrientationsFor:) in Unreal Engine's IOSAppDelegate.cpp file. This method returns the UIInterfaceOrientationMask value to apply to the game. A landscape-only game returns landscape, a portrait-only game returns portrait, and a game that supports both landscape and portrait returns both landscape and portrait.

Add the following code to /Engine/Source/Runtime/ApplicationCore/Private/IOS/IOSAppDelegate.cpp.

- (UIInterfaceOrientationMask)application:(UIApplication *)application supportedInterfaceOrientationsForWindow:(UIWindow *)window
{
  // TODO: Landscape-only game
  return UIInterfaceOrientationMaskLandscape;
  // TODO: Portrait-only game
  return UIInterfaceOrientationMaskPortrait;
  // TODO: Game that supports both landscape and portrait
  return UIInterfaceOrientationMaskAll;
}

Setting Swift compatibility (iOS)¶

In an iOS development environment, add the lines or blocks marked with 'Add' comments in the following files for compatibility between Unreal Engine 4 and the Swift language.

Engine/Source/Programs/UnrealBuildTool/ProjectFiles/Xcode/XcodeProject.cs

    {
       Content.Append("\t\t\t\t\"PRODUCT_BUNDLE_IDENTIFIER[sdk=iphoneos*]\" = " + IOS_BUNDLE + ";" + ProjectFileGenerator.NewLine);
    }
    // Add
    if (ProjectFile != null)
    {
        Content.Append("\t\t\t\tSWIFT_VERSION = 5.0;" + ProjectFileGenerator.NewLine);
        Content.Append("\t\t\t\tSWIFT_OBJC_BRIDGING_HEADER = \"" + GamePath + "/dummy-Bridging-Header.h\";" + ProjectFileGenerator.NewLine);
    }
   // Add End
}
if (TVOSRunTimeVersion != null)
{

if (XcodeProjectFileGenerator.bGeneratingRunIOSProject)
{
   Content.Append("\t\t\t\tALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;"+ ProjectFileGenerator.NewLine); // Add
   Content.Append("\t\t\t\tINFOPLIST_FILE = \"" + IOSInfoPlistPath + "\";" + ProjectFileGenerator.NewLine);
   Content.Append("\t\t\t\tCODE_SIGN_ENTITLEMENTS = \"" + IOSEntitlementPath + "\";" + ProjectFileGenerator.NewLine);
}

Content.Append("\t\t\t\t\"INFOPLIST_FILE[sdk=macosx*]\" = \"" + MacInfoPlistPath + "\";" + ProjectFileGenerator.NewLine);
if (IOSRunTimeVersion != null)
{
   Content.Append("\t\t\t\tALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;"+ ProjectFileGenerator.NewLine); // Add
   Content.Append("\t\t\t\t\"INFOPLIST_FILE[sdk=iphoneos*]\" = \"" + IOSInfoPlistPath + "\";" + ProjectFileGenerator.NewLine);
   Content.Append("\t\t\t\t\"CODE_SIGN_ENTITLEMENTS[sdk=iphoneos*]\" = \"" + IOSEntitlementPath + "\";" + ProjectFileGenerator.NewLine);
}

Engine/Source/Programs/UnrealBuildTool/Platform/IOS/IOSToolChain.cs

    Result += " -Xlinker \\\"" + Path.GetDirectoryName(OutputFile.AbsolutePath) + "\\\"";
}
Result += " -Xlinker -rpath -Xlinker /usr/lib/swift";  // Add
Result += " -dead_strip";
Result += " -m" + GetXcodeMinVersionParam() + "=" + ProjectSettings.RuntimeVersion;
Result += " -Wl";

Setting entitlements (iOS)¶

Unreal Engine dynamically creates the entitlements file for signing through UnrealBuildTool at build time. Add the required entitlement entries as follows.

• Add through project settings: Some common entitlement entries can be enabled directly in the Project Settings menu of the Unreal Editor.
• Add by modifying engine source: Other entries that are not supported in project settings must be added by directly modifying the entitlement generation code in the UnrealBuildTool engine source file below.
  • File to modify: Engine/Source/Programs/UnrealBuildTool/Platform/IOS/IOSExport.cs

The entitlement entries required for each Hive SDK feature and how to add them are as follows. Add only the entries for the features used by your app, which must also be enabled as capabilities in the provisioning profile. For details about each entry, see the official Apple documentation.

When modifying IOSExport.cs, add the required entries between 'Add' and 'Add End' at the location below.

Text.AppendLine( "<dict>");
Text.AppendLine( "\t<key>get-task-allow</key>");
Text.AppendLine(string.Format( "\t<{0}/>", bForDistribution ? "false": "true"));

// Add - Add the required entitlement entries. The following is a Game Center example.
Text.AppendLine("\t<key>com.apple.developer.game-center</key>");
Text.AppendLine("\t<true/>");
// Add End

if (bCloudKitSupported) {
    if (iCloudContainerIdentifiersXML != "")

After building, verify that the entitlements are applied to the app as follows.

codesign -d --entitlements :- {built .app path}

Applying HIVEAppDelegate (iOS)¶

Starting with Hive SDK v4 26.4.1, HIVEAppDelegate swizzling is performed automatically inside the Hive SDK plugin. The plugin handles this automatically when the app launches, so no additional work is required in the app code.