GameSession (JSON)
Um objeto JSON que representa dados de jogo para uma sessão multijogador. O objeto JSON GameSession tem a especificação a seguir.| Membro | Tipo | Descrição |
|---|---|---|
| creationTime | DateTime | A data e a hora em que a sessão foi criada, em UTC. |
| customData | matriz de inteiros sem sinal de 8 bits | 1024 bytes de dados de sessão específicos do jogo. Esse valor é opaco para o servidor. |
| displayName | string | O nome de exibição da sessão de jogo, com comprimento máximo de 128 caracteres. Esse valor é opaco para o servidor. |
| hasEnded | valor booliano | True se a sessão tiver terminado; caso contrário, false. Definir esse campo como true marca a sessão de jogo como somente leitura, impedindo que mais dados sejam enviados à sessão. |
| isClosed | valor booliano | True se a sessão estiver fechada e nenhum outro jogador puder ser adicionado; caso contrário, false. Se esse valor for true, as solicitações para ingressar na sessão serão rejeitadas. |
| maxPlayers | inteiro com sinal de 32 bits | Número máximo de jogadores que podem estar na sessão simultaneamente. O intervalo de valores é 2-16. Quando a sessão atinge o número máximo de jogadores, novas solicitações para ingressar na sessão são rejeitadas. |
| playersCanBeRemovedBy | PlayerAcl | Um valor que indica o jogador que tem permissão para remover outros jogadores da sessão. Os valores possíveis são NoOne, Self e AnyPlayer. |
| roster | matriz de objetos de jogador | Uma matriz de jogadores na sessão. A lista contém os jogadores atuais e os jogadores que estavam anteriormente na sessão, mas saíram. A ordem dos jogadores na lista nunca muda. Novos jogadores são adicionados ao final da matriz. |
| seatsAvailable | inteiro com sinal de 32 bits | O número de jogadores que ainda podem ingressar na sessão antes que o número máximo de jogadores seja atingido. Esse valor é somente leitura e é sempre menor que o valor do campo maxPlayers. |
| sessionId | string | A ID da sessão atribuída pelo MPSD quando a sessão é criada. Esse valor geralmente é incluído no URI ao acessar as informações armazenadas em uma sessão. |
| titleId | inteiro sem sinal de 32 bits | A ID do título que está criando a sessão de jogo. |
| variant | inteiro com sinal de 32 bits | A variante do jogo. Esse valor é opaco para o servidor. |
| visibility | VisibilityLevel | Um valor que indica a visibilidade da sessão. Os valores possíveis são: PlayersCurrentlyInSession, PlayersEverInSession e Everyone. |
Exemplo de sintaxe 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",
}