Amazon GameLift Servers データ型用のサーバー SDK (Unreal) - Amazon GameLift Servers
FDescribePlayerSessionsRequestFProcessParametersFStartMatchBackfillRequestFStopMatchBackfillRequest

Amazon GameLift Servers データ型用のサーバー SDK (Unreal)

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

注記

このリファレンスは、サーバー SDK for Amazon GameLift Servers の以前のバージョン用です。最新バージョンについては、「C++ (Unreal)サーバー SDK 5.x for Amazon GameLift Servers -- データ型」を参照してください。

この API は、GameLiftServerSDK.h と GameLiftServerSDKModels.h で定義されます。

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

サーバー SDK (Unreal) for Amazon GameLift Servers -- アクション

FDescribePlayerSessionsRequest

このデータ型は、取得するプレイヤーセッションを指定するのに使用されます。このデータ型は次のように使用できます。

  • 特定のプレーヤーセッションをリクエストする PlayerSessionId を提供します。

  • 指定したゲームセッションのすべてのプレイヤーセッションをリクエストする GameSessionId を提供します。

  • 指定したプレイヤーのすべてのプレイヤーセッションをリクエストする PlayerId を提供します。

プレイヤーセッション数が多い場合は、ページ分割パラメータを使用して結果を順次ブロックとして取得します。

内容

GameSessionId

一意のゲームセッション識別子。このパラメータを使用して、指定したゲームセッションのすべてのプレイヤーセッションをリクエストします。ゲームセッション ID の形式は、arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string> です。<ID string> の値は、カスタム ID 文字列または (ゲームセッション作成時に指定した場合) 生成された文字列のいずれかです。

型: String

必須: いいえ

制限

返される結果の最大数。このパラメータを NextToken とともに使用して、結果を一連の順次ページとして取得します。プレイヤーセッション ID を指定した場合、このパラメータは無視されます。

型: Integer

必須: いいえ

NextToken

結果において次の順次ページの開始を示すトークン。このアクションの以前の呼び出しで返されたトークンを使用します。結果セットの先頭を指定するには、値を指定しないでください。プレイヤーセッション ID を指定した場合、このパラメータは無視されます。

型: String

必須: いいえ

PlayerId

プレイヤーを表す一意の識別子。プレイヤー ID は開発者によって定義されます。「プレイヤー ID を生成する」を参照してください。

型: String

必須: いいえ

PlayerSessionId

プレイヤーセッションを表す一意の識別子。

型: String

必須: いいえ

PlayerSessionStatusFilter

結果をフィルタリングするプレイヤーセッションステータス。可能なプレイヤーセッションステータスとして以下のステータスがあります。

  • RESERVED – プレイヤーセッションリクエストは受領されましたが、プレイヤーのサーバープロセスへの接続や検証はまだ行われていません。

  • ACTIVE – プレイヤーはサーバープロセスによって検証され、現時点で接続されています。

  • COMPLETED – プレイヤー接続は削除されました。

  • TIMEDOUT – プレイヤーセッションリクエストは受領されましたが、タイムアウト制限 (60 秒) 内でのプレイヤーの接続や検証は行われていません。

型: String

必須: いいえ

FProcessParameters

このデータ型には、Amazon GameLift Servers 呼び出しで ProcessReady() サービスに送られたパラメータセットが含まれます。

内容

ポート

サーバープロセスが新しいプレイヤーの接続をリスニングするポート番号。値は、このゲームサーバービルドをデプロイするすべてのフリートで設定されているポート番号の範囲に含まれる必要があります。このポート番号は、ゲームセッションオブジェクトとプレイヤーセッションオブジェクトに含まれ、ゲームセッションがサーバープロセスに接続するときに使用します。

型: Integer

必須: はい

logParameters

ゲームセッションログファイルへのディレクトリパスのリストを含むオブジェクト。

型: TArray<FString>

必須: いいえ

onStartGameSession

Amazon GameLift Servers サービスが新しいゲームセッションを有効化するために呼び出す コールバック関数の名前です。Amazon GameLift Servers は、クライアントリクエスト CreateGameSession に応答して、この関数を呼び出します。コールバック関数は GameSession オブジェクト (Amazon GameLift Servers サービス API リファレンスで定義) を取得します。

型: FOnStartGameSession

必須: はい

onProcessTerminate

Amazon GameLift Servers サービスがサーバープロセスを強制シャットダウンするために呼び出すコールバック関数の名前。この関数を呼び出すと、Amazon GameLift Servers はサーバープロセスがシャットダウンするために 5 分間待ち、サーバープロセスをシャットダウンする前に ProcessEnding() 呼び出しで応答します。

型: FSimpleDelegate

必須: いいえ

onHealthCheck

Amazon GameLift Servers サービスがサーバープロセスにヘルスステータスレポートをリクエストするために呼び出すコールバック関数の名前です。Amazon GameLift Servers は、この関数を 60 秒ごとに呼び出します。この関数を呼び出した後、Amazon GameLift Servers はレスポンスを 60 秒ほど待ちます。レスポンスがなければ、サーバープロセスを異常と記録します。

型: FOnHealthCheck

必須: いいえ

onUpdateGameSession

Amazon GameLift Servers サービスが更新されたゲームセッションオブジェクトをサーバープロセスに渡すために呼び出すコールバック関数の名前です。Amazon GameLift Servers は、マッチバックフィルリクエストが処理され、更新されたマッチメーカーデータを提供できる状態になると、この関数を呼び出します。GameSession オブジェクト、ステータス更新 (updateReason)、およびマッチバックフィルチケット ID が渡されます。

型: FOnUpdateGameSession

必須: いいえ

FStartMatchBackfillRequest

このデータ型はマッチメーキングバックフィルリクエストの送信に使用します。この情報は、Amazon GameLift Servers 呼び出しで StartMatchBackfill() サービスに伝えられます。

内容

GameSessionArn

一意のゲームセッション識別子。API アクション GetGameSessionId() は ARN 形式の識別子を返します。

型: FString

必須: はい

MatchmakingConfigurationArn

このリクエストに使用されるマッチメーカーの ARN 形式の一意な識別子。元のゲームセッションの作成に使用されたマッチメーカーを見つけるには、ゲームセッションオブジェクトのマッチメーカーデータプロパティを確認します。マッチメーカーデータの詳細については「マッチメーカーデータの処理」を参照してください。

型: FString

必須: はい

プレイヤー

現在ゲームセッションに参加しているすべてのプレイヤーを表すデータのセット。マッチメーカーはこの情報を使用して、現在のプレイヤーとマッチする新しいプレイヤーを検索します。プレイヤーオブジェクトの形式の説明については、Amazon GameLift Servers API リファレンスガイドを参照してください。プレイヤー属性、ID、チームの割り当てを見つけるには、マッチメーカーデータプロパティのゲームセッションオブジェクトを参照してください。マッチメーカーでレイテンシーが使用されている場合は、現在のリージョンの更新されたレイテンシーを収集し、それを各プレイヤーのデータに含めます。

型: TArray<FPlayer>

必須: はい

TicketId

マッチメーキングまたはバックフィルリクエストチケットの一意の識別子。ここで値を指定しない場合、Amazon GameLift Serversによって UUID 形式で自動的に生成されます。この識別子を使用してマッチバックフィルチケットのステータスを追跡したり、必要に応じてリクエストをキャンセルしたりします。

型: FString

必須: いいえ

FStopMatchBackfillRequest

このデータ型はマッチメーキングバックフィルリクエストのキャンセルに使用します。この情報は、Amazon GameLift Servers 呼び出しで StopMatchBackfill() サービスに伝えられます。

内容

GameSessionArn

キャンセルされるリクエストに関連付けられた一意のゲームセッション識別子。

型: FString

必須: はい

MatchmakingConfigurationArn

このリクエストが送信されたマッチメーカーの一意の識別子。

型: FString

必須: はい

TicketId

キャンセルされるバックフィルリクエストチケットの一意の識別子。

型: FString

必須: はい