翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Unreal Engine SDK用 Amazon GameLift サーバー: アクション

Amazon GameLift サーバー SDK for Unreal リファレンスを使用して、ホスト用のマルチプレイヤーゲームを Amazon と統合します GameLift。統合プロセスに関するガイダンスについては、「」を参照してくださいAmazon GameLift をゲームサーバーに追加する。

これはAPI、 GameLiftServerSDK.hおよび で定義されますGameLiftServerSDKModels.h。

Unreal Engine プラグインを設定するには、コードサンプル「Amazon GameLift を Unreal Engine プロジェクトに統合する」を参照してください。

Unreal Engine SDK用 Amazon GameLift サーバー: データ型

AcceptPlayerSession()

指定されたプレイヤーセッション ID を持つプレイヤーがサーバープロセスに接続しており、検証が必要であることを Amazon GameLift サービスに通知します。Amazon は、プレイヤーセッション ID が有効であること、つまりプレイヤー ID がゲームセッションでプレイヤースロットを予約し GameLift ていることを確認します。検証されると、Amazon はプレイヤースロットのステータスを から RESERVED GameLift に変更しますACTIVE。

構文

FGameLiftGenericOutcome AcceptPlayerSession(const FString& playerSessionId)

パラメータ

戻り値

正常またはエラーメッセージを伴うエラーの、一般的な結果を返します。

ActivateGameSession()

サーバープロセスがゲームセッションをアクティブ化し、プレイヤー接続を受信する準備が整ったことを Amazon GameLift サービスに通知します。このアクションは、すべてのゲームセッションの初期化が完了した後、onStartGameSession() コールバック関数の一部として呼び出されます。

構文

FGameLiftGenericOutcome ActivateGameSession()

パラメータ

このアクションにはパラメータがありません。

戻り値

正常またはエラーメッセージを伴うエラーの、一般的な結果を返します。

DescribePlayerSessions()

設定、セッションメタデータ、プレイヤーデータを含む、プレイヤーセッションデータを取得します。このアクションを使用して、単一のプレイヤーセッション、ゲームセッション内のすべてのプレイヤーセッション、または単一のプレイヤー ID に関連付けられたすべてのプレイヤーセッションに関する情報を取得します。

構文

FGameLiftDescribePlayerSessionsOutcome DescribePlayerSessions(const FGameLiftDescribePlayerSessionsRequest &describePlayerSessionsRequest)

パラメータ

戻り値

成功した場合は、リクエストのパラメータに適合したプレイヤーセッションオブジェクトのセットを含む FDescribePlayerSessionsRequest オブジェクトを返します。プレイヤーセッションオブジェクトの構造は Amazon GameLift API PlayerSession データ型と同じです AWS SDK。

GetGameSessionId()

サーバープロセスがアクティブな場合、サーバープロセスが現在ホストしているゲームセッションの ID を取得します。

構文

FGameLiftStringOutcome GetGameSessionId()

パラメータ

このアクションにはパラメータがありません。

戻り値

成功した場合、ゲームセッション ID を FGameLiftStringOutcome オブジェクトとして返します。成功しなかった場合、エラーメッセージを返します。

GetInstanceCertificate()

フリートとそのインスタンスに関連付けられている pem エンコードされたTLS証明書のファイルの場所を取得します。証明書設定を に設定して新しいフリートを作成すると、この証明書 AWS Certificate Manager が生成されますGENERATED。この証明書を使用して、ゲームクライアントとのセキュリティ保護ありの接続を確立し、クライアント/サーバー通信を暗号化します。

構文

FGameLiftGetInstanceCertificateOutcome GetInstanceCertificate()

パラメータ

このアクションにはパラメータがありません。

戻り値

成功すると、 はフリートのTLS証明書ファイルと証明書チェーンの場所を含むGetInstanceCertificateOutcomeオブジェクトを返します。このオブジェクトはインスタンスに保存されます。証明書チェーンから抽出されたルート証明書ファイルもインスタンスに保存されます。成功しなかった場合、エラーメッセージを返します。

証明書と証明書チェーンデータの詳細については、 リファレンスのGetCertificate 「レスポンス要素 AWS Certificate Manager API」を参照してください。

GetSdkVersion()

サーバープロセスに組み込まれSDKている の現在のバージョン番号を返します。

構文

FGameLiftStringOutcome GetSdkVersion();

パラメータ

このアクションにはパラメータがありません。

戻り値

成功すると、 は現在のSDKバージョンをFGameLiftStringOutcomeオブジェクトとして返します。返される文字列は、バージョン番号のみを含みます(例: 3.1.5)。成功しなかった場合、エラーメッセージを返します。

例

Aws::GameLift::AwsStringOutcome SdkVersionOutcome = 
    Aws::GameLift::Server::GetSdkVersion(); 

初期化 SDK()

Amazon を初期化します GameLift SDK。このメソッドは、他の Amazon GameLift関連の初期化が発生する前に、起動時に呼び出す必要があります。

構文

FGameLiftGenericOutcome InitSDK()

パラメータ

このアクションにはパラメータがありません。

戻り値

正常またはエラーメッセージを伴うエラーの、一般的な結果を返します。

ProcessEnding()

サーバープロセスがシャットダウンしていることを Amazon GameLift サービスに通知します。このメソッドは、すべてのアクティブゲームセッションのシャットダウンを含む他のすべてのクリーンアップタスクの後に呼び出されます。このメソッドは、終了コード 0 で終了します。0 以外の終了コードでは、処理が問題なく終了しなかったというイベントメッセージが発生します。

構文

FGameLiftGenericOutcome ProcessEnding()

パラメータ

このアクションにはパラメータがありません。

戻り値

正常またはエラーメッセージを伴うエラーの、一般的な結果を返します。

ProcessReady()

サーバープロセスがゲームセッションをホストする準備ができていることを Amazon GameLift サービスに通知します。このメソッドは、初期化 SDK() の呼び出しが成功して必要な設定タスクが完了した後、サーバープロセスがゲームセッションをホストできるようになる前に呼び出す必要があります。このメソッドは、プロセスごとに 1 回だけ呼び出す必要があります。

構文

FGameLiftGenericOutcome ProcessReady(FProcessParameters &processParameters)

パラメータ

戻り値

正常またはエラーメッセージを伴うエラーの、一般的な結果を返します。

例

Using the Unreal Engine Plugin にあるサンプルコードを参照してください。

RemovePlayerSession()

指定されたプレイヤーセッション ID を持つプレイヤーがサーバープロセスから切断されたことを Amazon GameLift サービスに通知します。これに応じて、Amazon はプレイヤースロットを使用可能 GameLift に変更し、新しいプレイヤーに割り当てることができます。

構文

FGameLiftGenericOutcome RemovePlayerSession(const FString& playerSessionId)

パラメータ

戻り値

正常またはエラーメッセージを伴うエラーの、一般的な結果を返します。

StartMatchBackfill()

で作成されたゲームセッションで、開いているスロットの新しいプレイヤーを検索するリクエストを送信します FlexMatch。アクション StartMatchBackfill() も参照してください AWS SDK。このアクションを使用すると、ゲームセッションをホストするゲームサーバーのプロセスによってマッチバックフィルリクエストを開始できます。 FlexMatch バックフィル機能 の詳細については、「」を参照してください。

このアクションは非同期です。新しいプレイヤーが正常に一致した場合、Amazon GameLift サービスはコールバック関数 を使用して更新されたマッチメーカーデータを提供しますOnUpdateGameSession()。

サーバープロセスではアクティブなマッチバックフィルリクエストは一度に 1 つだけです。新しいリクエストを送信するには、まず StopMatchBackfill() を呼び出して元のリクエストをキャンセルする必要があります。

構文

FGameLiftStringOutcome StartMatchBackfill (FStartMatchBackfillRequest &startBackfillRequest);

パラメータ

戻り値

成功した場合、マッチバックフィルチケットを FGameLiftStringOutcome オブジェクトとして返します。成功しなかった場合、エラーメッセージを返します。チケットのステータスは、 アクション DescribeMatchmaking() を使用して AWS SDK追跡できます。

StopMatchBackfill()

StartMatchBackfill() とともに作成されたアクティブなマッチバックフィルリクエストをキャンセルします。 AWS SDK アクション StopMatchmaking() も参照してください。 FlexMatch バックフィル機能 の詳細については、「」を参照してください。

構文

FGameLiftGenericOutcome StopMatchBackfill (FStopMatchBackfillRequest &stopBackfillRequest);

パラメータ

戻り値

正常またはエラーメッセージを伴うエラーの、一般的な結果を返します。

TerminateGameSession()

このメソッドは、バージョン 4.0.1 で非推奨となりました。代わりに、サーバープロセスはゲームセッションが終了した後に ProcessEnding() を呼び出す必要があります。

サーバープロセスが現在のゲームセッションを終了したことを Amazon GameLift サービスに通知します。このアクションは、サーバープロセスがアクティブなままになり、新しいゲームセッションをホストするための準備ができたときに呼び出されます。これは、ゲームセッションの終了手順が完了した後にのみ呼び出す必要があります。これは、サーバープロセスが新しいゲームセッションをホストするためにすぐに利用できる GameLift ことを Amazon に知らせます。

ゲームセッションが停止した後にサーバープロセスがシャットダウンされる場合は、このアクションは呼び出されません。代わりに、ProcessEnding() を呼び出し、ゲームセッションとサーバープロセスの両方が終了していることを通知します。

構文

FGameLiftGenericOutcome TerminateGameSession()

パラメータ

このアクションにはパラメータがありません。

戻り値

正常またはエラーメッセージを伴うエラーの、一般的な結果を返します。

UpdatePlayerSessionCreationPolicy()

現在のゲームセッションの機能を更新し、新しいプレイヤーセッションを承諾します。ゲームセッションは、新しいプレイヤーセッションをすべて受け入れるか拒否するかを設定できます。（Amazon GameLift Service API Reference の UpdateGameSession()アクションも参照してください）。

構文

FGameLiftGenericOutcome UpdatePlayerSessionCreationPolicy(EPlayerSessionCreationPolicy policy)

パラメータ

戻り値

正常またはエラーメッセージを伴うエラーの、一般的な結果を返します。