GameSession (JSON)
Un objeto JSON que representa datos de juego de una sesión multijugador. El objeto JSON GameSession tiene la siguiente especificación.| Miembro | Tipo | Descripción |
|---|---|---|
| creationTime | DateTime | La fecha y hora en que se creó la sesión, en UTC. |
| customData | matriz de enteros sin signo de 8 bits | 1024 bytes de datos de sesión específicos del juego. Este valor es opaco para el servidor. |
| displayName | string | El nombre para mostrar de la sesión de juego, con una longitud máxima de 128 caracteres. Este valor es opaco para el servidor. |
| hasEnded | valor booleano | True si la sesión ha finalizado y false en caso contrario. Establecer este campo en true marca la sesión de juego como de solo lectura, lo que impide que se envíen más datos a la sesión. |
| isClosed | valor booleano | True si la sesión está cerrada y no se pueden agregar más jugadores, y false en caso contrario. Si este valor es true, se rechazan las solicitudes de unión a la sesión. |
| maxPlayers | entero con signo de 32 bits | Número máximo de jugadores que pueden estar en la sesión de forma simultánea. El intervalo de valores es 2-16. Cuando la sesión contiene el número máximo de jugadores, se rechazan las solicitudes adicionales de unión a la sesión. |
| playersCanBeRemovedBy | PlayerAcl | Un valor que indica qué jugador puede quitar a otros jugadores de la sesión. Los valores posibles son NoOne, Self y AnyPlayer. |
| roster | matriz de objetos player | Una matriz de los jugadores de la sesión. La lista contiene los jugadores actuales y los jugadores que estuvieron anteriormente en la sesión, pero que la han abandonado. El orden de los jugadores en la lista nunca cambia. Los jugadores nuevos se agregan al final de la matriz. |
| seatsAvailable | entero con signo de 32 bits | El número de jugadores que aún pueden unirse a la sesión antes de alcanzar el número máximo de jugadores. Este valor es de solo lectura y siempre es menor que el valor del campo maxPlayers. |
| sessionId | string | El identificador de sesión asignado por el MPSD cuando se crea la sesión. Este valor suele incluirse en el URI al acceder a la información almacenada en una sesión. |
| titleId | entero sin signo de 32 bits | El identificador del título que crea la sesión de juego. |
| variant | entero con signo de 32 bits | La variante del juego. Este valor es opaco para el servidor. |
| visibility | VisibilityLevel | Un valor que indica la visibilidad de la sesión. Los valores posibles son: PlayersCurrentlyInSession, PlayersEverInSession y Everyone. |
Sintaxis JSON de ejemplo
{
"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",
}