Amazon GameLift サーバー SDK (C#) リファレンス: データ型 - Amazon GameLift
LogParametersDescribePlayerSessionsRequestProcessParametersStopMatchBackfillRequest

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

Amazon GameLift サーバー SDK (C#) リファレンス: データ型

この Amazon GameLift C# サーバー SDK リファレンスは、Amazon GameLift で使用するマルチプレイヤーゲームを準備するのに役立ちます。統合プロセスの詳細については、「Amazon GameLift をゲームサーバーに追加する」を参照してください。

LogParameters

このデータ型は、ゲームセッション中に生成されたファイルのうち、ゲームセッション終了時に Amazon GameLift でアップロードして保存するファイルを識別するのに使用されます。この情報は、ProcessReady() 呼び出しで Amazon GameLift サービスに伝えられます。

目次

logPaths

Amazon GameLift で将来のアクセスに備えて保存するゲームサーバーログファイルへのディレクトリパスのリスト。これらのファイルは各ゲームセッション中にサーバープロセスによって生成されます。ファイルのパスと名前は、ゲームサーバー内に定義され、ルートゲームビルドディレクトリに保存されます。ログパスは絶対パスである必要があります。たとえば、ゲームビルドによって MyGame\sessionlogs\ などのパスに保存されるゲームセッションログのログパスは c:\game\MyGame\sessionLogs (Windows インスタンスの場合) または /local/game/MyGame/sessionLogs (Linux インスタンスの場合) となります。

型: List<String>

必須: いいえ

DescribePlayerSessionsRequest

このデータ型は、取得するプレイヤーセッションを指定するのに使用されます。複数の方法で使用できます。(1) 特定のプレイヤーセッションをリクエストする PlayerSessionId; を使用します。(2) 指定したゲームセッションのすべてのプレイヤーをリクエストするには、GameSessionId を指定します。または、(3) 指定したプレイヤーのすべてのプレイヤーセッションをリクエストするには、PlayerId を指定します。プレイヤーセッション数が多い場合は、ページ分割パラメータを使用して結果を順次ページとして取得します。

目次

GameSessionId

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

型: 文字列

必須: いいえ

制限

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

型: 整数

必須: いいえ

NextToken

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

型: 文字列

必須: いいえ

PlayerId

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

型: 文字列

必須: いいえ

PlayerSessionId

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

型: 文字列

必須: いいえ

PlayerSessionStatusFilter

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

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

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

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

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

型: 文字列

必須: いいえ

ProcessParameters

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

目次

port

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

型: 整数

必須: はい

logParameters

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

タイプ: Aws::GameLift::Server::LogParameters

必須: はい

onStartGameSession

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

タイプ: void OnStartGameSessionDelegate(GameSession gameSession)

必須: はい

onProcessTerminate

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

タイプ: void OnProcessTerminateDelegate()

必須: はい

onHealthCheck

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

タイプ: bool OnHealthCheckDelegate()

必須: はい

onUpdateGameSession

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

タイプ: void OnUpdateGameSessionDelegate ( UpdateGameSession updateGameSession )

必須: いいえ

StartMatchBackfillRequest

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

目次

GameSessionArn

一意のゲームセッション識別子。SDK メソッド GetGameSessionId() は ARN 形式の識別子を返します。

型: 文字列

必須: はい

MatchmakingConfigurationArn

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

型: 文字列

必須: はい

プレイヤー

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

型: プレイヤー[ ]

必須: はい

TicketId

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

型: 文字列

必須: いいえ

StopMatchBackfillRequest

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

目次

GameSessionArn

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

型: 文字列

必須: はい

MatchmakingConfigurationArn

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

型: 文字列

必須: はい

TicketId

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

型: 文字列

必須: はい