Online Services プラグインをセットアップおよび設定する

Online Services プラグインは、Epic、Steam、Xbox Live、PSN、NLPN などさまざまなバックエンドのオンライン サービスを Unreal Engine (UE) プロジェクトに接続するのに役立ちます。このガイドでは、以下の方法について説明します。

• Online Services プラグインを有効にする。
• Online Services プラグインをプロジェクトの依存関係に追加する。
• プロジェクトにデフォルトのサービスを設定する。

Online Services プラグインをセットアップする

このウォークスルーでは、例として Online Services Null 実装を使用しています。この実装はバックエンドのオンライン サービスに接続しておらず、テストのために使用しています。Online Services Null プラグインは Unreal Engine で作業するために外部登録またはコンフィギュレーションが必要ないので、これはよい開始点になります。Online Services プラグインでサポートされているサービスのリストについては、「Online Services の概要」ドキュメントを参照してください。

Online Services プラグインを有効にする

さまざまな Online Services プラグインをプロジェクトで使用できます。Online Services ベース プラグインはデフォルトで有効になっています。

追加の必要な機能を有効にするには、以下の手順に従います。

1. Unreal Engine C++ プロジェクトを作成するか、これを開きます。
2. メニュー バーで、[Edit (編集)] > [Plugins (プラグイン)] に移動します。新しいウィンドウまたは [Plugins (プラグイン)] というタイトルのタブを開きます。
   1. この新しいウィンドウで、「Online Services」を検索するか、左側のナビゲーション バーから [Online Platform (オンラインプラットフォーム)] カテゴリを選択します。
   2. プラグインの数が表示されます。これらのいずれかは Online Services Null というタイトルです。ボックスを選択して、Online Services Null プラグインを有効にします。

   (w:800)

   バックエンドのオンライン サービスに Epic Online Services を使用する場合、Online Services Null ではなく、Online Services EOS を選択します。これを行うには、製品を Epic Online Services に登録して、Online Services プラグインが想定どおりに動作するように適切にバックエンドを設定する必要があります。

   1. 「You must restart Unreal Editor for your changes to take effect (加えた変更を有効にするには、Unreal Editor を再起動する必要があります)」というメッセージが表示されます。[Restart Now (今すぐ再起動)] をクリックして、Unreal Editor を再起動します。
3. これで、プロジェクトで Online Services Null プラグインが有効になりました。

Online Services プラグインをプロジェクトの依存関係に追加する

Online Services プラグインをプロジェクトの C++ コードで使用するには、プラグインをプロジェクト モジュールにパブリック依存関係として追加する必要があります。

プラグインをプロジェクト モジュールのパブリック依存関係に追加するには、以下の手順に従います。

1. Unreal Editor で Unreal Engine C++ プロジェクトを開きます。
2. [Tools (ツール)] > [Open Visual Studio (Visual Studio を開く)] を選択して、Visual Studio を開きます。これにより、Visual Studio でプロジェクトの C++ ソース ファイルが開きます。
3. Online Services プラグインで提供されている C++ コードを使用するには、OnlineServicesInterface モジュールをパブリック依存関係としてプロジェクトの「.Build.cs」ファイルに追加する必要があります。
4. プロジェクトの「.Build.cs」ファイルを [Solution Explorer] から開くには、[Games (ゲーム)] > [YOUR_GAME] > [Source (ソース)] > [YOUR_GAME] > [YOUR_GAME].Build.cs に移動します。

5. OnlineServicesInterface と CoreOnline を .Build.cs パブリック依存関係に追加します。.Build.cs ファイルは次のようになります。

        // Copyright Epic Games, Inc. All Rights Reserved.
   		
        using UnrealBuildTool;
   		
        public class MyProject : ModuleRules
        {
            public MyProject(ReadOnlyTargetRules Target) : base(Target)
            {
                PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs;
                PublicDependencyModuleNames.AddRange(new string[] { 
                    "Core", 
                    "CoreUObject", 
                    "Engine", 
                    "InputCore", 
                    "EnhancedInput", 
                    "OnlineServicesInterface", 
                    "CoreOnline" 
                });
            }
        }
   Copy full snippet

   // Copyright Epic Games, Inc. All Rights Reserved. using UnrealBuildTool; public class MyProject : ModuleRules { public MyProject(ReadOnlyTargetRules Target) : base(Target) { PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs; PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject", "Engine", "InputCore", "EnhancedInput", "OnlineServicesInterface", "CoreOnline" }); } }
6. 変更を Visual Studio に保存します。

プロジェクト ファイルを生成する

変更をプロジェクトの .Build.cs ファイルに加えたので、Visual Studio プロジェクト ファイルをリフレッシュする必要があります。これにより、加えた変更が Visual Studio Intellisense に反映され、追加したプラグインの機能を使用できるようになります。

プロジェクト ファイルを生成するには、以下の手順に従います。

1. Visual Studio を閉じます。
2. Unreal Editor で開いているプロジェクトに戻ります。
3. [Tools] > [Refresh Visual Studio Project (Visual Studio プロジェクトのリフレッシュ)] を選択して、Visual Studio プロジェクト ファイルを再生成します。

プログレス バーが表示され、コード プロジェクトへの更新ステータスを示し、プロセスが完了したときに消えます。

デフォルトのプラットフォーム サービスを設定する

最後の手順では、Online Services プラグインのデフォルトのプラットフォーム サービスを指定します。デフォルトのプラットフォーム サービスは、UE::Online::GetServices を呼び出して返されるバックエンド プラットフォーム サービスを指定します。使用可能なプラットフォーム識別子のリストについては、「Overview of Online Services の概要」ドキュメント ページを参照してください。

Online Services Null をデフォルトのプラットフォーム サービスとして指定するには、次の手順に従います。

1. プロジェクトを Visual Studio で開きます。これを行うには、Unreal Editor 内で [Tools] > [Open Visual Studio (Visual Studio を開く)] に移動します。
2. プロジェクトの「DefaultEngine.ini」ファイルを Visual Studio の [Solution Explorer (ソリューション エクスプローラー)] で開くには、[Games] > [YOUR_GAME] > [Configs (コンフィグ)] > DefaultEngine.ini に移動します。

3. プロジェクトの「DefaultEngine.ini」ファイルに次を追加します。

        [OnlineServices]
        DefaultServices=Null
   Copy full snippet

   [OnlineServices] DefaultServices=Null

Online Services Null は、バックエンドのオンライン サービスを使用しないオンライン サービスの実装です。これは、バックエンドのオンライン サービスなしでオンラインサービスの実装をテストおよびデバッグするために使用されています。別のバックエンドのオンライン サービスをプロジェクトのデフォルト オンライン サービスとして使用する場合、「Online Services の概要」の「コンフィギュレーション」セクションで提供されているリストからいずれかを選択できます。

プロジェクトの Online Services にアクセスする

プロジェクトで使用するために、Online Services プラグインが有効になっていて設定されています。Online Services プラグインとその各種インターフェースにアクセスするには、以下の手順に従います。

1. #include "Online/OnlineServices.h" を Online Services プラグインにアクセスするファイルに追加します。
2. IOnlineServicesPtr OnlineServicesPtr = UE::Online::GetServices(); でデフォルトのプラットフォーム サービスへのポインタを取得します。

これで、さまざまな Online Services プラグイン インターフェースの機能にアクセスできるようになりました。たとえば、Auth インターフェース にアクセスするには、以下の手順に従います。

1. デフォルトのプラットフォーム サービスへのポインタを取得していることを確認します。
2. #include "Online/Auth.h" を Auth インターフェースにアクセスするファイルに追加します。
3. 次のように、Auth インターフェースへのポインタを取得します。IAuthPtr AuthPtr = OnlineServicesPtr->GetAuthInterface();

これで、Auth インターフェースのポインタで Auth インターフェースの機能にアクセスできるようになりました。同じロジックが他のすべての Online Services インターフェースで機能します。