GameSession (JSON)
マルチプレイヤー セッションのゲーム データを表す JSON オブジェクト。 GameSession JSON オブジェクトの仕様は次のとおりです。| メンバー | 型 | 説明 |
|---|---|---|
| creationTime | DateTime | セッションが作成された日時 (UTC)。 |
| customData | 8 ビット符号なし整数の配列 | ゲーム固有のセッション データ 1024 バイト。この値はサーバーにとっては不透明です。 |
| displayName | string | ゲーム セッションの表示名。最大長は 128 文字。この値はサーバーにとっては不透明です。 |
| hasEnded | ブール値 | セッションが終了している場合は true、そうでない場合は false。このフィールドを true に設定すると、ゲーム セッションが読み取り専用としてマークされ、それ以上のデータがセッションに送信されなくなります。 |
| isClosed | ブール値 | セッションがクローズされ、これ以上プレイヤーを追加できない場合は true、そうでない場合は false。この値が true の場合、セッションへの参加リクエストは拒否されます。 |
| maxPlayers | 32 ビット符号付き整数 | セッションに同時に参加できるプレイヤーの最大数。値の範囲は 2 ～ 16 です。セッション内のプレイヤー数が最大に達すると、以降のセッション参加リクエストは拒否されます。 |
| playersCanBeRemovedBy | PlayerAcl | セッションから他のプレイヤーを削除することが許可されているプレイヤーを示す値。指定可能な値は NoOne、Self、AnyPlayer です。 |
| roster | player オブジェクトの配列 | セッション内のプレイヤーの配列。ロスターには、現在のプレイヤーと、過去にセッションに参加していたが退出したプレイヤーが含まれます。ロスター内のプレイヤーの順序は変更されません。新しいプレイヤーは配列の末尾に追加されます。 |
| seatsAvailable | 32 ビット符号付き整数 | 最大プレイヤー数に達する前にまだセッションに参加できるプレイヤーの数。この値は読み取り専用で、常に maxPlayers フィールドの値より小さくなります。 |
| sessionId | string | セッションが作成された際に MPSD によって割り当てられたセッション ID。この値は通常、セッションに保存された情報にアクセスするときに URI に含まれます。 |
| titleId | 32 ビット符号なし整数 | ゲーム セッションを作成するタイトルの ID。 |
| variant | 32 ビット符号付き整数 | ゲームのバリアント。この値はサーバーにとっては不透明です。 |
| visibility | VisibilityLevel | セッションの可視性を示す値。指定可能な値は PlayersCurrentlyInSession、PlayersEverInSession、Everyone です。 |
サンプル JSON 構文
{
"sessionId": "702e5aaf-e7bd-4a7c-abea-9dd4be10edec",
"titleId": 1297287259,
"variant": 1,
"displayName": "Contoso Cards",
"creationTime": "2011-06-23T17:13:06Z",
"customData": null,
"maxPlayers": 4,
"seatsAvailable": 4,
"isClosed": false,
"hasEnded": false,
"roster": [],
"visibility": "PlayersCurrentlyInSession",
"playersCanBeRemovedBy": "Self",
}