GameSession (JSON)
マルチプレイヤー セッションのゲーム データを表す JSON オブジェクト。
GameSession JSON オブジェクトの仕様は以下のとおりです。
| メンバー | 種類 | 説明 |
|---|---|---|
| creationTime | DateTime | UTC で表したセッションの作成日時。 |
| customData | 8 ビット符号なし整数の配列 | 1024 バイトのゲーム固有のセッション データ。 この値はサーバーに対して非透過的です。 |
| displayName | 文字列 | ゲーム セッションの表示名 (最大の長さは 128 文字)。 この値はサーバーに対して非透過的です。 |
| hasEnded | ブール値 | セッションが終了している場合は true、それ以外の場合は false。 このフィールドを true に設定するとゲーム セッションは読み取り専用になり、以後データがセッションに送信されなくなります。 |
| isClosed | ブール値 | セッションが閉じられ、プレイヤーを追加できない場合は true、それ以外の場合は false。 この値が true の場合、セッションへの参加要求は拒否されます。 |
| maxPlayers | 32 ビット符号付き整数 | セッションに同時参加できるプレイヤーの最大数。 値の範囲は 2 ～ 16 です。 セッションのプレイヤーが最大数に達すると、以後、セッションへの参加要求は拒否されます。 |
| playersCanBeRemovedBy | PlayerAcl | プレイヤーが他のプレイヤーをセッションから削除することを許可されているかどうかを示す値。 可能な値は NoOne、Self、および AnyPlayer です。 |
| roster | プレイヤー オブジェクトの配列 | セッション内のプレイヤーの配列。 ロスターには、現在のプレイヤーと、以前にセッションに参加していたが退出したプレイヤーが含まれます。 ロスターのプレイヤーの順序は変更できません。 新しいプレイヤーは、配列の末尾に追加されます。 |
| seatsAvailable | 32 ビット符号付き整数 | プレイヤーの最大数に到達する前にまだセッションに参加できるプレイヤーの数。 この値は読み取り専用で、常に maxPlayers フィールドの値より小さい値です。 |
| sessionId | 文字列 | セッションが作成されるときに 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",
}
関連項目
親
JavaScript Object Notation (JSON) オブジェクト リファレンス