Amazon GameLift サーバー SDK 5.x for C++: データ型 - Amazon GameLift
LogParametersProcessParametersUpdateGameSessionGameSessionServerParametersStartMatchBackfillRequestプレイヤーDescribePlayerSessionsRequestStopMatchBackfillRequestAttributeValueGetFleetRoleCredentialsRequestAwsLongOutcomeAwsStringOutcomeDescribePlayerSessionsOutcomeDescribePlayerSessionsResultGenericOutcomeGenericOutcomeCallablePlayerSessionStartMatchBackfillOutcomeStartMatchBackfillResultGetComputeCertificateOutcomeGetComputeCertificateResultGetFleetRoleCredentialsOutcomeGetFleetRoleCredentialsResultInitSDKOutcomeGameLiftError列挙型

Amazon GameLift サーバー SDK 5.x for C++: データ型

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

注記

このトピックでは、C++ 標準ライブラリ (std) を使用して構築するときに使用できる Amazon GameLift C++ API について説明します。特に、このドキュメントは -DDGAMELIFT_USE_STD=1 オプションを使用してコンパイルするコードが対象です。

Amazon GameLift サーバー SDK 5.x for C++: アクション

LogParameters

ゲームセッション中に生成されたファイルを識別するオブジェクトで、ゲームセッション終了時に Amazon GameLift でアップロードして保存します。ゲームサーバーは、ProcessReady() 呼び出しでの ProcessParameters オブジェクトの一部として LogParameters を Amazon GameLift に提供します。

プロパティ

 説明
LogPaths

Amazon GameLift で将来のアクセスに備えて保存するゲームサーバーログファイルへのディレクトリパスのリスト。サーバープロセスは各ゲームセッション中にこれらのファイルを生成します。ファイルのパスと名前はゲームサーバーで定義し､ルートゲームビルドディレクトリに保存します。

ログパスは絶対パスである必要があります。例えば、ゲームビルドによって MyGame\sessionLogs\ などのパスに保存されるゲームセッションログの場合、パスは c:\game\MyGame\sessionLogs (Windows インスタンスの場合) となります。

タイプ: std:vector<std::string>

必須: いいえ

ProcessParameters

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

プロパティ

 説明
LogParameters ゲームセッション中に生成されるファイルへのディレクトリパスを含むオブジェクト。Amazon GameLift は、今後アクセスできるようにファイルをコピーして保存します。

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

必須: いいえ
OnHealthCheck Amazon GameLift がサーバープロセスにヘルスステータスレポートをリクエストするために呼び出すコールバック関数。Amazon GameLift は、この関数を 60 秒ごとに呼び出し、応答があるまで 60 秒待ちます。サーバープロセスは正常であれば TRUE を返し、正常でない場合は FALSE を返します。応答が返されない場合、Amazon GameLift はサーバープロセスを正常ではないと記録します。

タイプ: std::function<bool()> onHealthCheck

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

タイプ: std::function<void()> onProcessTerminate

必須: はい
OnRefreshConnection Amazon GameLift がゲームサーバーとの接続を更新するために呼び出すコールバック関数の名前。

タイプ: void OnRefreshConnectionDelegate()

必須: はい
onStartGameSession Amazon GameLift が新しいゲームセッションをアクティブにするために呼び出すコールバック関数。Amazon GameLift はクライアントのリクエスト CreateGameSession に応じ、この関数を呼び出します。コールバック関数は GameSession オブジェクトを渡します。

タイプ: const std::function<void(Aws::GameLift::Model::GameSession)> onStartGameSession

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

タイプ: std::function<void(Aws::GameLift::Server::Model::UpdateGameSession)> onUpdateGameSession

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

タイプ: Integer

必須: はい

UpdateGameSession

このデータ型はゲームセッションオブジェクトに更新されます。これには、ゲームセッションが更新された理由と、バックフィルを使用してゲームセッション内のプレイヤーセッションを埋めるための関連するバックフィルチケット ID が含まれます。

プロパティ 説明
GameSession GameSession オブジェクト。GameSession オブジェクトにはゲームセッションを説明するプロパティが含まれています。

タイプ: Aws::GameLift::Server::GameSession

必須: はい
UpdateReason ゲームセッションが更新されている理由。

タイプ: Aws::GameLift::Server::UpdateReason

必須: はい
BackfillTicketId ゲームセッションの更新を試みるバックフィルチケットの ID。

タイプ: std::string

必須: いいえ

GameSession

このデータ型はゲームセッションの詳細を提供します。

プロパティ 説明
GameSessionId

ゲームセッションの一意の識別子。ゲームセッション ARN の形式 は arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> です。

タイプ: std::string

必須: いいえ
名前

ゲームセッションについて説明するラベル。

タイプ: std::string

必須: いいえ
FleetId

ゲームセッションが実行されているフリートの一意の識別子。

タイプ: std::string

必須: いいえ
MaximumPlayerSessionCount

ゲームセッションへのプレーヤー接続の最大数。

タイプ: int

必須: いいえ
ポート

ゲームセッションのポート番号。Amazon GameLift ゲームサーバーに接続するには、アプリに IP アドレスとポート番号の両方が必要です。

タイプ: in

必須: いいえ
IP アドレス

ゲームセッションの IP アドレス。Amazon GameLift ゲームサーバーに接続するには、アプリに IP アドレスとポート番号の両方が必要です。

タイプ: std::string

必須: いいえ
GameSessionData

単一の文字列値としてフォーマットされたカスタムゲームセッションプロパティのセット。

タイプ: std::string

必須: いいえ
MatchmakerData

ゲームセッションの作成に使用されたマッチメーキングプロセスに関する情報。JSON 構文で、文字列としてフォーマットされています。使用されたマッチメーキング設定に加えて、プレイヤー属性やチーム割り当てなど、マッチに割り当てられた全プレイヤーに関するデータが含まれます。

タイプ: std::string

必須: いいえ
GameProperties

ゲームセッションのカスタムプロパティのセットで、キーと値のペアとしてフォーマットされます。これらのプロパティは、新しいゲームセッションを開始するリクエストとともに渡されます。

タイプ: std :: vector < GameProperty >

必須: いいえ
DnsName

ゲームセッションを実行しているインスタンスに割り当てられた DNS 識別子。値の形式は次のとおりです。

  • TLS 対応フリート: <unique identifier>.<region identifier>.amazongamelift.com。

  • TLS 対応でないフリート: ec2-<unique identifier>.compute.amazonaws.com。

TLS 対応フリートで実行しているゲームセッションに接続する場合、IP アドレスではなく DNS 名を使用する必要があります。

タイプ: std::string

必須: いいえ

ServerParameters

ゲームサーバープロセスが Amazon GameLift サービスとの接続を確立するために使用する情報。ゲームサーバービルドが、Amazon GameLift エージェントエージェントなしで、Anywhere フリートまたはコンテナフリートにデプロイされる場合のみ InitSDK() を呼び出す際に、これらのパラメータを含めます。他のすべてのデプロイシナリオでは、パラメータなしで InitSDK() が呼び出されます。

プロパティ 説明
webSocketUrl

Amazon GameLift Anywhere コンピューティングリソースに RegisterCompute を実行すると、GameLiftServerSdkEndpoint Amazon GameLift が返します。

タイプ: std::string

必須: はい

processId

ゲームをホストするサーバープロセスに登録された固有の識別子。

タイプ: std::string

必須: はい
hostId HostID はコンピューティングを登録したときに使用される ComputeName です。詳細については、「RegisterCompute」を参照してください。

タイプ: std::string

必須: はい
fleetId コンピューティングが登録されているフリートの固有識別子。詳細については、「RegisterCompute」を参照してください。

タイプ: std::string

必須: はい
authToken Amazon GameLift によって生成された認証トークンで、Amazon GameLift に対してサーバーを認証します。詳細については、「GetComputeAuthToken」を参照してください。

タイプ: std::string

必須: はい

StartMatchBackfillRequest

マッチメーキングバックフィルリクエストの作成に使用される情報。この情報は、StartMatchBackfill() 呼び出しで Amazon GameLift に伝えられます。

プロパティ 説明
GameSessionArn

一意のゲームセッション識別子。API オペレーション GetGameSessionId は ARN 形式の識別子を返します。

タイプ: std::string

必須: はい
MatchmakingConfigurationArn

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

タイプ: std::string

必須: はい
プレイヤー

ゲームセッションに参加しているすべてのプレイヤーを表すデータのセット。マッチメーカーはこの情報を使用して、現在のプレイヤーとマッチする新しいプレイヤーを検索します。

タイプ: std::vector<Player>

必須: はい
TicketId

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

タイプ: std::string

必須: いいえ

プレイヤー

このデータ型はマッチメーキングのプレイヤーを表します。マッチメーキングリクエストを開始すると、プレイヤーはプレイヤー ID、属性、場合によってはレイテンシーデータを保有します。Amazon GameLift は、マッチが行われた後にチーム情報を追加します。

プロパティ 説明
LatencyInMS

プレイヤーがロケーションに接続したときに発生するレイテンシーの量を示すミリ秒単位の値のセット。

このプロパティを使用すると、プレーヤーはリストに表示されている場所でのみマッチングされます。マッチメーカーにプレイヤーレイテンシーを評価するルールがある場合、プレイヤーはレイテンシーを報告しないとマッチングされません。

タイプ: Dictionary<string,int>

必須: いいえ
PlayerAttributes

マッチメーキングに使用するプレイヤー情報を含むキーと値のペアの集合。プレイヤー属性キーは、マッチメーキングルールセットで使用されているプレイヤー属性と一致する必要があります。

プレイヤー属性の詳細については、「AttributeValue」を参照してください。

タイプ: std::map<std::string,AttributeValue>

必須: いいえ
PlayerId

プレイヤーを表す一意の識別子。

タイプ: std::string

必須: いいえ
Team

マッチでプレーヤーが割り当てられるチームの名前。チーム名はマッチメーキングルールセットで定義します。

タイプ: std::string

必須: いいえ

DescribePlayerSessionsRequest

取得するプレイヤーセッションを指定するオブジェクト。サーバープロセスはこの情報を Amazon GameLift への DescribePlayerSessions() 呼び出しで提供します。

プロパティ 説明
GameSessionId

一意のゲームセッション識別子。このパラメータを使用して、指定したゲームセッションのすべてのプレイヤーセッションをリクエストします。

ゲームセッション ID の形式は arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string> です。GameSessionID はカスタム ID 文字列または

タイプ: std::string

必須: いいえ
PlayerSessionId

プレイヤーセッションを表す一意の識別子。このパラメータを使用して、特定の 1 つのプレイヤーセッションをリクエストします。

タイプ: std::string

必須: いいえ
PlayerId

プレイヤーの一意識別子。このパラメータを使用して、特定の 1 人のプレイヤーに対するすべてのプレイヤーセッションをリクエストします。「プレイヤー ID を生成する」を参照してください。

タイプ: std::string

必須: いいえ
PlayerSessionStatusFilter

結果をフィルタリングするプレイヤーセッションステータス。可能なプレイヤーセッションステータスには以下が含まれます。

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

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

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

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

タイプ: std::string

必須: いいえ
NextToken

結果の次のページの先頭を示すトークン。結果セットの先頭を指定するには、値を指定しないでください。プレイヤーセッション ID を提供する場合、このパラメータは無視されます。

タイプ: std::string

必須: いいえ
制限

返される結果の最大数。プレイヤーセッション ID を提供する場合、このパラメータは無視されます。

タイプ: int

必須: いいえ

StopMatchBackfillRequest

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

プロパティ 説明
GameSessionArn

キャンセルされるリクエストの一意のゲームセッション識別子。

タイプ: char[]

必須: いいえ
MatchmakingConfigurationArn

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

タイプ: char[]

必須: いいえ
TicketId

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

タイプ: char[]

必須: いいえ

AttributeValue

これらの値を プレイヤー 属性のキーと値のペアで使用します。このオブジェクトでは、文字列、数値、文字列配列、データマップのいずれかの有効なデータ型を使用して属性値を指定できます。各 AttributeValue オブジェクトは S、N、SL、または SDM の使用可能なプロパティのうちの 1 つだけを使用する必要があります。

プロパティ 説明
AttrType

属性値のタイプを指定します。可能な属性値のタイプは次のとおりです。

  • なし

  • STRING

  • DOUBLE

  • STRING_LIST

  • STRING_DOUBLE_MAP

必須: いいえ
S

文字列の属性値を表します。

タイプ: std::string

必須: いいえ
N

数値の属性値を表します。

タイプ: double

必須: いいえ
SL

文字列の属性値の配列を表します。

タイプ: std::vector<std::string>

必須: いいえ
SDM

文字列キーと二重値のディクショナリを表します。

タイプ: std::map<std::string, double>

必須: いいえ

GetFleetRoleCredentialsRequest

このデータ型により、ゲームサーバーは他の AWS リソースへのアクセスが制限されます。詳細については、「Amazon GameLift の IAM サービスロールをセットアップする」を参照してください。

プロパティ 説明
RoleArn AWS リソースへの制限付きアクセスを拡張するサービスロールの Amazon リソースネーム (ARN)。

タイプ: std::string

必須: いいえ
RoleSessionName AWS Security Token Service AssumeRole セッションを一意に識別するために使用できるロールセッション名。この名前は、CloudTrail などの監査ログに公開されます。

タイプ: std::string

必須: いいえ

AwsLongOutcome

このデータ型はアクションの結果で、以下のプロパティを持つオブジェクトを生成します。

プロパティ 説明
結果

アクションの結果。

タイプ: long

必須: いいえ
ResultWithOwnership

アクションの結果を rvalue としてキャストし、呼び出し元のコードがオブジェクトの所有権を取得できるようにします。

タイプ: long&&

必須: いいえ
成功

アクションが成功したかどうか。

タイプ: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

タイプ: GameLiftError

必須: いいえ

AwsStringOutcome

このデータ型はアクションの結果で、以下のプロパティを持つオブジェクトを生成します。

プロパティ 説明
結果

アクションの結果。

タイプ: std::string

必須: いいえ
ResultWithOwnership

アクションの結果を rvalue としてキャストし、呼び出し元のコードがオブジェクトの所有権を取得できるようにします。

タイプ: long&&

必須: いいえ
成功

アクションが成功したかどうか。

タイプ: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

タイプ: GameLiftError

必須: いいえ

DescribePlayerSessionsOutcome

このデータ型はアクションの結果で、以下のプロパティを持つオブジェクトを生成します。

プロパティ 説明
結果

アクションの結果。

タイプ: DescribePlayerSessionsResult

必須: いいえ

ResultWithOwnership

アクションの結果を rvalue としてキャストし、呼び出し元のコードがオブジェクトの所有権を取得できるようにします。

タイプ: Aws::GameLift::Server::Model::DescribePlayerSessionsResult&&

必須: いいえ
成功

アクションが成功したかどうか。

タイプ: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

タイプ: GameLiftError

必須: いいえ

DescribePlayerSessionsResult

リクエストに一致する各プレイヤーセッションのプロパティを含むオブジェクトの集合。

プロパティ 説明
NextToken

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

タイプ: std::string

必須: はい
PlayerSessions

タイプ: IList<PlayerSession>

必須:

ResultWithOwnership

アクションの結果を rvalue としてキャストし、呼び出し元のコードがオブジェクトの所有権を取得できるようにします。

タイプ: std::string&&

必須: いいえ
成功

アクションが成功したかどうか。

タイプ: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

タイプ: GameLiftError

必須: いいえ

GenericOutcome

このデータ型はアクションの結果で、以下のプロパティを持つオブジェクトを生成します。

プロパティ 説明
成功

アクションが成功したかどうか。

タイプ: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

タイプ: GameLiftError

必須: いいえ

GenericOutcomeCallable

このデータ型は非同期の一般的な結果です。以下のプロパティがあります。

プロパティ 説明
成功

アクションが成功したかどうか。

タイプ: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

タイプ: GameLiftError

必須: いいえ

PlayerSession

このデータ型は、Amazon GameLift がゲームサーバーに渡すプレイヤーセッションを表します。詳細については、「PlayerSession」を参照してください。

プロパティ 説明
CreationTime

タイプ: long

必須: いいえ
FleetId

タイプ: std::string

必須: いいえ
GameSessionId

タイプ: std::string

必須: いいえ
IP アドレス

タイプ: std::string

必須: いいえ
PlayerData

タイプ: std::string

必須: いいえ
PlayerId

タイプ: std::string

必須: いいえ
PlayerSessionId

タイプ: std::string

必須: いいえ
ポート

タイプ: int

必須: いいえ
ステータス

結果をフィルタリングするプレイヤーセッションステータス。PlayerSessionId または PlayerId が提供された場合、PlayerSessionStatusFilter はレスポンスに影響を与えません。

Type: A PlayerSessionStatus enum. 以下に示しているのは、可能な値です。

  • ACTIVE

  • COMPLETED

  • NOT_SET

  • RESERVED

  • TIMEDOUT

必須: いいえ
TerminationTime

タイプ: long

必須: いいえ
DnsName

タイプ: std::string

必須: いいえ

StartMatchBackfillOutcome

このデータ型はアクションの結果で、以下のプロパティを持つオブジェクトを生成します。

プロパティ 説明
結果

アクションの結果。

タイプ: StartMatchBackfillResult

必須: いいえ
ResultWithOwnership

アクションの結果を rvalue としてキャストし、呼び出し元のコードがオブジェクトの所有権を取得できるようにします。

タイプ: StartMatchBackfillResult&&

必須: いいえ
成功

アクションが成功したかどうか。

タイプ: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

タイプ: GameLiftError

必須: いいえ

StartMatchBackfillResult

このデータ型はアクションの結果で、以下のプロパティを持つオブジェクトを生成します。

プロパティ 説明
TicketId

マッチメーキングチケットの一意の識別子。ここでチケット ID を指定しない場合、Amazon GameLift によって UUID 形式で自動的に生成されます。この識別子を使用して、マッチバックフィルチケットのステータスを追跡し、マッチ結果を取得します。

タイプ: std::string

必須: いいえ

GetComputeCertificateOutcome

このデータ型はアクションの結果で、以下のプロパティを持つオブジェクトを生成します。

プロパティ 説明
結果

アクションの結果。

タイプ: GetComputeCertificateResult

必須: いいえ

ResultWithOwnership

アクションの結果を rvalue としてキャストし、呼び出し元のコードがオブジェクトの所有権を取得できるようにします。

タイプ: Aws::GameLift::Server::Model::GetComputeCertificateResult&&

必須: いいえ
成功

アクションが成功したかどうか。

タイプ: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

タイプ: GameLiftError

必須: いいえ

GetComputeCertificateResult

コンピューティングの TLS 証明書へのパスとコンピューティングのホスト名。

プロパティ 説明
CertificatePath

コンピューティングリソースの TLS 証明書へのパス。Amazon GameLift マネージドフリートを使用する場合、このパスには以下が含まれます。

  • certificate.pem: エンドユーザー証明書。証明書チェーン全体は、この証明書に追加された certificateChain.pem を組み合わせたものです。

  • certificateChain.pem: ルート証明書と中間証明書を含む証明書チェーン。

  • rootCertificate.pem: ルート証明書。

  • privateKey.pem: エンドユーザー証明書のプライベートキー。

タイプ: std::string

必須: いいえ
ComputeName

コンピューティングリソースの名前。

タイプ: std::string

必須: いいえ

GetFleetRoleCredentialsOutcome

このデータ型はアクションの結果で、以下のプロパティを持つオブジェクトを生成します。

プロパティ 説明
結果

アクションの結果。

タイプ: GetFleetRoleCredentialsResult

必須: いいえ

ResultWithOwnership

アクションの結果を rvalue としてキャストし、呼び出し元のコードがオブジェクトの所有権を取得できるようにします。

タイプ: Aws::GameLift::Server::Model::GetFleetRoleCredentialsResult

必須: いいえ
成功

アクションが成功したかどうか。

タイプ: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

タイプ: GameLiftError

必須: いいえ

GetFleetRoleCredentialsResult

プロパティ 説明
AccessKeyId

AWS へのアクセスを認証して提供するためのアクセスキー ID。

タイプ: string

必須: いいえ
AssumedRoleId

サービスロールが属するユーザーの ID。

タイプ: string

必須: いいえ
AssumedRoleUserArn

サービスロールが属するユーザーの Amazon リソースネーム (ARN)。

タイプ: string

必須: いいえ
有効期限

セッション認証情報の有効期限が切れるまでの時間。

タイプ: DateTime

必須: いいえ
SecretAccessKey

認証のためのシークレットアクセスキー ID。

タイプ: string

必須: いいえ
SessionToken

AWS リソースとやり取りしている現在のアクティブなセッションを識別するトークン。

タイプ: string

必須: いいえ
成功

アクションが成功したかどうか。

タイプ: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

タイプ: GameLiftError

必須: いいえ

InitSDKOutcome

注記

InitSDKOutcome は std フラグを付けて SDK を構築した場合にのみ返されます。nostd フラグを付けて構築すると、代わりに GenericOutcome が返されます。

プロパティ 説明
成功

アクションが成功したかどうか。

タイプ: bool

必須: はい
エラー

アクションが失敗した場合に発生したエラー。

タイプ: GameLiftError

必須: いいえ

GameLiftError

プロパティ 説明
ErrorType

エラーのタイプ。

Type: A GameLiftErrorType enum.

必須: いいえ

ErrorName

エラータイプの名前。

タイプ: std::string

必須: いいえ

ErrorMessage

エラーメッセージです。

タイプ: std::string

必須: いいえ

列挙型

Amazon GameLift サーバー SDK (C++) に定義された列挙値は次のように定義されます。

GameLiftErrorType

エラータイプを示す文字列値。有効な値を次に示します。

  • BAD_REQUEST_EXCEPTION

  • GAMESESSION_ID_NOT_SET – ゲームセッション ID が設定されていません。

  • INTERNAL_SERVICE_EXCEPTION

  • LOCAL_CONNECTION_FAILED – Amazon GameLift へのローカル接続に失敗しました。

  • NETWORK_NOT_INITIALIZED – ネットワークは初期化されていません。

  • SERVICE_CALL_FAILED – AWS サービスへの呼び出しが失敗しました。

  • WEBSOCKET_CONNECT_FAILURE

  • WEBSOCKET_CONNECT_FAILURE_FORBIDDEN

  • WEBSOCKET_CONNECT_FAILURE_INVALID_URL

  • WEBSOCKET_CONNECT_FAILURE_TIMEOUT

  • ALREADY_INITIALIZED – Amazon GameLift サーバーまたはクライアントはすでに Initialize() で初期化されています。

  • FLEET_MISMATCH – ターゲットフリートがゲームセッションまたはプレイヤーセッションのフリートと一致しません。

  • GAMELIFT_CLIENT_NOT_INITIALIZED – Amazon GameLift クライアントは初期化されていません。

  • GAMELIFT_SERVER_NOT_INITIALIZED – Amazon GameLift クライアントは初期化されていません。

  • GAME_SESSION_ENDED_FAILED – Amazon GameLift サーバー SDK はサービスにアクセスしてゲームセッションが終了したことを報告できませんでした。

  • GAME_SESSION_ENDED_FAILED – Amazon GameLift サーバーのゲームセッションがアクティブ化されませんでした。

  • GAME_SESSION_READY_FAILED – Amazon GameLift サーバー SDK は、サービスにアクセスしてゲームセッションの準備が完了したことを報告できませんでした。

  • INITIALIZATION_MISMATCH – Server:: Initialize() の後にクライアントメソッドが呼び出されました。その逆も同様です。

  • NOT_INITIALIZED – Amazon GameLift サーバーまたはクライアントはすでに Initialize() で初期化されていません。

  • NO_TARGET_ALIASID_SET – ターゲットのエイリアスが設定されていません。

  • NO_TARGET_FLEET_SET – ターゲットフリートが設定されていません。

  • PROCESS_ENDING_FAILED – Amazon GameLift サーバー SDK はサービスにアクセスしてプロセスの終了を報告できませんでした。

  • PROCESS_NOT_ACTIVE – サーバープロセスはまだアクティブではなく、GameSession にバインドされていないため、プレイヤーセッションを受け入れたり処理したりすることはできません。

  • PROCESS_NOT_READY – サーバープロセスをまだアクティブ化する準備ができていません。

  • PROCESS_READY_FAILED – Amazon GameLift サーバー SDK はサービスにアクセスしてプロセスの準備が完了したことを報告できませんでした。

  • SDK_VERSION_DETECTION_FAILED – SDK バージョン検出に失敗しました。

  • STX_CALL_FAILED – XSTX サーバーのバックエンドコンポーネントへの呼び出しが失敗しました。

  • STX_INITIALIZATION_FAILED – XSTX サーバーのバックエンドコンポーネントが初期化に失敗しました。

  • UNEXPECTED_PLAYER_SESSION – 未登録のプレイヤーセッションがサーバーによって検出されました。

  • WEBSOCKET_CONNECT_FAILURE

  • WEBSOCKET_CONNECT_FAILURE_FORBIDDEN

  • WEBSOCKET_CONNECT_FAILURE_INVALID_URL

  • WEBSOCKET_CONNECT_FAILURE_TIMEOUT

  • WEBSOCKET_RETRIABLE_SEND_MESSAGE_FAILURE – GameLift Service WebSocket にメッセージを送信する際に再試行可能な障害が発生しました。

  • WEBSOCKET_SEND_MESSAGE_FAILURE – GameLift Service WebSocket へのメッセージの送信に失敗しました。

  • MATCH_BACKFILL_REQUEST_VALIDATION – リクエストの検証に失敗しました。

  • PLAYER_SESSION_REQUEST_VALIDATION – リクエストの検証に失敗しました。

PlayerSessionCreationPolicy

ゲームセッションで新しいプレイヤーを承諾するかどうかを示す文字列値。有効な値を次に示します。

  • ACCEPT_ALL – すべての新しいプレイヤーセッションを承諾します。

  • DENY_ALL – すべての新しいプレイヤーセッションを拒否します。

  • NOT_SET – ゲームセッションは、新規プレイヤーセッションを受け入れたり拒否したりするように設定されていません。