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

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

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

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

注記

このリファレンスは、Amazon GameLift サーバー の以前のバージョン用ですSDK。最新バージョンについては、 を参照してください。

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

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

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

FDescribePlayerSessionsRequest

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

  • 特定のプレイヤーセッションをリクエスト PlayerSessionId するには、 を指定します。

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

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

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

内容

GameSessionId

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

型: 文字列

必須: いいえ

制限

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

タイプ: 整数

必須:いいえ

NextToken

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

型: 文字列

必須: いいえ

PlayerId

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

型: 文字列

必須: いいえ

PlayerSessionId

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

型: 文字列

必須: いいえ

PlayerSessionStatusFilter

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

  • RESERVED – プレイヤーセッションリクエストを受信しましたが、プレイヤーがサーバープロセスにまだ接続していないか、検証されていません。

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

  • COMPLETED – プレイヤー接続が切断されました。

  • TIMEDOUT – プレイヤーセッションリクエストを受信しましたが、プレイヤーが接続しなかったか、タイムアウト制限 (60 秒) 内で検証されませんでした。

型: 文字列

必須: いいえ

FProcessParameters

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

内容

port

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

型: 整数

必須:はい

logParameters

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

タイプ: TArray<FString>

必須:いいえ

onStartGameセッション

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

タイプ: FOnStartGameSession

必須:はい

onProcessTerminate

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

タイプ: FSimpleDelegate

必須:いいえ

onHealthCheck

Amazon GameLift サービスがサーバープロセスからヘルスステータスレポートをリクエストするために呼び出すコールバック関数の名前。Amazon は 60 秒ごとにこの関数を GameLift 呼び出します。この関数を呼び出すと、Amazon は応答を 60 秒 GameLift 待機し、何も受信されない場合、 はサーバープロセスを異常として記録します。

タイプ: FOnHealthCheck

必須:いいえ

onUpdateGameセッション

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

タイプ: FOnUpdateGameSession

必須:いいえ

FStartMatchBackfillRequest

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

内容

GameSessionArn

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

タイプ: FString

必須:はい

MatchmakingConfigurationArn

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

タイプ: FString

必須:はい

プレイヤー

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

タイプ: TArray<FPlayer>

必須:はい

TicketId

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

タイプ: FString

必須:いいえ

FStopMatchBackfillRequest

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

内容

GameSessionArn

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

タイプ: FString

必須:はい

MatchmakingConfigurationArn

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

タイプ: FString

必須:はい

TicketId

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

タイプ: FString

必須:はい