Online Services コンソール コマンドを使用して、ゲームプレイ時に Online Services プラグインのデバッグおよびテストを行います。
コンソール コマンドを実行する
Online Services プラグイン コンソール コマンドは、Unreal Editor (UE) のコンソールから実行されます。コンソールは、チルダ (~) キーを 1 回 (フィードバックなしの場合) または 2 回 (詳細なフィードバックの場合) 押して、プレイインエディタ (PIE) でアクセスできます。Online Services コンソール コマンドを実行するには、次の構文を使用します。
OnlineServices Index=<NUM> <INTERFACE> <FUNCTION> [ARG1] [ARG2] ...
パラメータ
次の表に、Online Services プラグイン コンソール コマンドを構成するパラメータを示します。
| パラメータ | 説明 | 追加情報 |
|---|---|---|
NUM |
アクセスするサービスのインデックス数。 |
|
INTERFACE |
アクセスする機能を備えているインターフェース。 |
|
FUNCTION |
指定されたインターフェース内で使用する関数。 |
|
ARG1, ARG2, … |
宣言された順に FUNCTION の 関連する Param 構造体を構成する引数。 |
|
Online Services コンソール コマンドの例については、本ページの「コンソール コマンドの例」セクションを参照してください。
引数
Online Services の関数では、さまざまなパラメータ タイプを渡す必要があります。Online Services コンソール コマンドでは、Online Services 関数を実行するためのメカニズムを提供しているので、これらの関数のパラメータ タイプに対応したさまざまなコンソール コマンドの引数型が実装されています。Online Services コンソール コマンドには、これらの型を処理する固有の方法があります。これは Unreal Engine コンソールを通じて C++ の複雑な型を渡す際に役立つので、これらの関数での型の使用が認識されるようになります。
固有の型は次のとおりです。
- FAccountId
- TSharedPtr
- TOptional
- TVariant
- Objects
- TArray
- TMap
以下の表は、これらの特殊な型をそれぞれ渡す方法とその例に関する詳細を示しています。
| 型 | 情報 | 例 |
|---|---|---|
FAccountId |
|
|
TSharedPtr |
通常どおりのパラメータ名のタイプ。
|
|
TOptional |
オプションの未設定の値を渡すには、null を使用します。 |
|
TVariant |
TVariant を渡す構文は、
カスタム列挙型がある場合、Online Services コンソール コマンドで適切に機能させるには、マクロ |
以下に、各型および型と値のペアの例を示します。
|
Objects |
すべてのパラメータをフラットに宣言するには、オブジェクトを中かっこで区切る構文をオンライン メタデータとともに使用します。オブジェクトは、内部オブジェクトと配列をサポートしています。 | 以下に、オブジェクトの例をいくつか示します。
|
TArray |
TArray には、角かっこで区切る構文を使用します。リスト内の値を区切るカンマはオプションです。 |
以下に、相互に等しい同じ
|
TMap |
TMap には、中かっこで区切る構文を使用します。TMap ではリッチな構文をサポートしていないため、ネストされたオブジェクトや配列などは正しく解析されない可能性があります。 |
以下に、
|
コンソール コマンドの例
このセクションでは、プロジェクトで Online Services プラグインを有効にして使用できるコンソール コマンドの例を示します。Online Services コンソール コマンドを使用するには、次の作業を完了していることを確認します。
- Online Services プラグインの有効化。
- プロジェクト用に使用できるようにプラグインの設定。
- プロジェクトのコードで使用したいサービスへの参照を取得。
使用するサービスへの参照を取得しておらず、各インターフェースを適切に設定していない場合、これらのコンソール コマンドは、プロジェクトで以下のように動作しない可能性があります。
使用可能な Online Services を一覧表示する
コマンド
OnlineServices List
このコマンドは、Online Services プラグインを通じてアクセスできるプラットフォーム サービスを一覧表示します。
出力例
0: Null
1: Epic
2: Steam
...
この出力例では、複数のオンライン プラットフォーム サービスを使用でき、適切なインデックス番号を使用して Online Services コンソール コマンドで参照できます。たとえば、Null は Index=0 で、Epic は Index=1 で、Steam は Index=2 で参照できます。
ローカル オンライン ユーザーを取得する
コマンド
OnlineServices Index=0 Auth GetLocalOnlineUserByPlatformUserId 0
出力例
LogConsoleResponse: Display: GetLocalOnlineUserByPlatformUserId result: { AccountInfo: [{ AccountId: Null:1 (ID_STRING), PlatformUserId: 0, LoginStatus: LoggedIn, Attributes: {DisplayName:String:ID_STRING} }] }
タイトル ファイルを取得する
コマンド
OnlineServices Index=0 TitleFile GetEnumeratedFiles 0
出力例
LogConsoleResponse: Display: GetEnumeratedFiles result: { Filenames: [StatusFile] }
この出力では、「StatusFile」というタイトルのバックエンド オンライン サービスに登録されたタイトル ファイルが 1 つあることを示しています。
詳細情報
このページで説明されているトピックの詳細については、以下のページを参照してください。