MultiplayerSessionRequest (JSON)

为 MultiplayerSession 对象上的操作传递的请求 JSON 对象。

MultiplayerSessionRequest JSON 对象具有以下规范。

成员	类型	说明
constants	对象	与会话模板合并以生成会话常量的只读设置。
properties	对象	更改为合并到会话属性中。
members.me	对象	工作方式与其顶层对应项非常相似的常量和属性。 任何 PUT 方法都要求用户是会话的成员，在必要时将添加用户。 如果“me”被指定为 null，发起请求的成员将被从会话中删除。
members	对象	表示要添加到会话的用户的其他对象，由从零开始的索引键控。 请求中的成员数始终以 0 开头，即使会话已经包含成员。 成员按照它们在请求中显示的顺序添加到会话。 成员属性只能由其所属的用户设置。
servers	对象	一些值，指示会话的关联服务器参与者集的更新和添加。 如果某服务器被指定为 null，系统将从会话中删除该服务器条目。

请求结构

{
  "constants": { /* Property Bag */ },
  "properties": { /* Property Bag */ },
  "members": {
    // Requires a service principal. Existing members can be deleted by index.
    // Not available on large sessions.
    "5": null,

    // Reservation requests must start with zero. New users will get added in order to the end of the session's member list.
    // Large sessions don't support reservations.
    "reserve_0": {
      "constants": { /* Property Bag */ }
    },
    "reserve_1": {
      "constants": { /* Property Bag */ }
    },

    // Requires a user principal with a xuid claim. Can be 'null' to remove myself from the session.
    "me": {
      "constants": { /* Property Bag */ },
      "properties": { /* Property Bag */ },
    }
  },

  // Requires a server principal.
  "servers": {
    // Can be any name. The value can be 'null' to remove the server from the session.
    "name": {
      "constants": {  /* Property Bag */ },
      "properties": {  /* Property Bag */ }
    }
  }
}

另请参阅

父级

JavaScript 对象表示法 (JSON) 对象参考

参考

MultiplayerSession (JSON)

PUT (/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/sessions/{sessionName})