GameSession (JSON)
Un objet JSON représentant les données de jeu d’une session multijoueur. L’objet JSON GameSession présente la spécification suivante.| Membre | Type | Description |
|---|---|---|
| creationTime | DateTime | La date et l’heure de création de la session, en UTC. |
| customData | tableau d’entiers non signés 8 bits | 1 024 octets de données de session propres au jeu. Cette valeur est opaque pour le serveur. |
| displayName | string | Le nom d’affichage de la session de jeu, d’une longueur maximale de 128 caractères. Cette valeur est opaque pour le serveur. |
| hasEnded | valeur booléenne | True si la session est terminée, false sinon. Définir ce champ à true marque la session de jeu en lecture seule, ce qui empêche la soumission de données supplémentaires à la session. |
| isClosed | valeur booléenne | True si la session est fermée et qu’aucun autre joueur ne peut être ajouté, false sinon. Si cette valeur est true, les demandes pour rejoindre la session sont rejetées. |
| maxPlayers | entier signé 32 bits | Nombre maximal de joueurs pouvant se trouver simultanément dans la session. La plage de valeurs est de 2 à 16. Une fois que la session contient le nombre maximal de joueurs, les autres demandes pour rejoindre la session sont rejetées. |
| playersCanBeRemovedBy | PlayerAcl | Une valeur qui indique le joueur autorisé à retirer d’autres joueurs de la session. Les valeurs possibles sont NoOne, Self et AnyPlayer. |
| roster | tableau d’objets player | Un tableau des joueurs de la session. La liste contient les joueurs actuels et les joueurs qui étaient précédemment dans la session, mais qui l’ont quittée. L’ordre des joueurs dans la liste ne change jamais. Les nouveaux joueurs sont ajoutés à la fin du tableau. |
| seatsAvailable | entier signé 32 bits | Le nombre de joueurs qui peuvent encore rejoindre la session avant que le nombre maximal de joueurs soit atteint. Cette valeur est en lecture seule et est toujours inférieure à la valeur du champ maxPlayers. |
| sessionId | string | L’ID de session attribué par le MPSD lors de la création de la session. Cette valeur est habituellement incluse dans l’URI lors de l’accès aux informations stockées dans une session. |
| titleId | entier non signé 32 bits | L’ID du titre qui crée la session de jeu. |
| variant | entier signé 32 bits | La variante du jeu. Cette valeur est opaque pour le serveur. |
| visibility | VisibilityLevel | Une valeur qui indique la visibilité de la session. Les valeurs possibles sont : PlayersCurrentlyInSession, PlayersEverInSession et Everyone. |
Exemple de syntaxe 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",
}