CreateRoomRequest (cn.leancloud.play:multiplayer-server-plugin 1.13 API)

java.lang.Object
- cn.leancloud.play.plugin.request.AbstractRequest
- - cn.leancloud.play.plugin.request.CreateRoomRequest

All Implemented Interfaces:: RoomRequest

public final class CreateRoomRequest
extends AbstractRequest

Constructor Summary

Constructors
Constructor and Description

CreateRoomRequest(Map<clojure.lang.Keyword,Object> requestParams)

Constructors
Constructor and Description
`CreateRoomRequest(Map<clojure.lang.Keyword,Object> requestParams)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateRoomRequest`	`exposeRoom()` 暴露房间。设置后所有玩家都能在大厅上查看、自动匹配到本房间
`PlayObject`	`getCustomRoomProperties()` 获取房间自定义属性
`List<String>`	`getCustomRoomPropertyKeysForLobby()` 获取用于房间匹配的房间自定义属性键。不在本列表内的房间自定义属性不会用来做房间匹配
`int`	`getEmptyRoomTtlSecs()` 获取空房间保留时间，默认为 0 表示房间内玩家全部离开后，房间会立即被销毁
`List<String>`	`getExpectedUserIds()` 获取房间指定的玩家 ID 列表。这个参数主要用于为某些能加入到房间中的特定玩家「占位」。
`int`	`getMaxPlayerCount()` 获取最大房间人数参数
`int`	`getPlayerTtlSecs()` 获取玩家允许的最大离线时间，默认为 0 表示玩家一旦断线就自动从房间离开
`CreateRoomRequest`	`hideRoom()` 隐藏房间。设置后只能通过房间名称加入本房间
`boolean`	`isVisible()` 房间是否可见。默认为可见，即所有玩家都能在大厅上查看、自动匹配到本房间
`CreateRoomRequest`	`setEmptyRoomTtl(long ttl, TimeUnit unit)` 设置空房间保留时间，默认为 0 表示房间内玩家全部离开后，房间会立即被销毁
`CreateRoomRequest`	`setExpectUsers(List<String> expectUsers)` 设置房间指定的玩家 ID 列表。这个参数主要用于为某些能加入到房间中的特定玩家「占位」。
`CreateRoomRequest`	`setLobbyKeys(List<String> keys)` 设置用于房间匹配的房间自定义属性键。不在本列表内的房间自定义属性不会用来做房间匹配
`CreateRoomRequest`	`setMaxPlayerCount(int max)` 设置最大房间人数
`CreateRoomRequest`	`setPlayerTtl(long ttl, TimeUnit unit)` 设置玩家允许的最大离线时间，默认为 0 表示玩家一旦断线就自动从房间离开
`CreateRoomRequest`	`setRoomProperties(PlayObject attr)` 设置房间自定义属性
`String`	`toString()`

Methods inherited from class cn.leancloud.play.plugin.request.AbstractRequest
equals, getAllInternalParameters, getRoomName, getUserId, hashCode, setReadOnly

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateRoomRequest
```
public CreateRoomRequest(Map<clojure.lang.Keyword,Object> requestParams)
```
- Method Detail
  - getMaxPlayerCount
```
public int getMaxPlayerCount()
```
    获取最大房间人数参数
    
    Returns:
    
    最大房间人数
  - setMaxPlayerCount
```
public CreateRoomRequest setMaxPlayerCount(int max)
```
    设置最大房间人数
    
    Parameters:
    
    max - 不能小于 0，如果设置的过大超过了 Game Server 的允许限制会被限制为 Game Server 最大允许值
    
    Returns:
    
    this
  - getEmptyRoomTtlSecs
```
public int getEmptyRoomTtlSecs()
```
    获取空房间保留时间，默认为 0 表示房间内玩家全部离开后，房间会立即被销毁
    
    Returns:
    
    返回空房间保留时间
  - setEmptyRoomTtl
```
public CreateRoomRequest setEmptyRoomTtl(long ttl,
                                         TimeUnit unit)
```
    设置空房间保留时间，默认为 0 表示房间内玩家全部离开后，房间会立即被销毁
    
    Parameters:
    
    ttl - 空房间保留时间，不能小于 0，如果设置的过大超过了 Game Server 的允许限制会被限制为 Game Server 最大允许值
    
    unit - 空房间保留时间单位
    
    Returns:
    
    this
  - getPlayerTtlSecs
```
public int getPlayerTtlSecs()
```
    获取玩家允许的最大离线时间，默认为 0 表示玩家一旦断线就自动从房间离开
    
    Returns:
    
    返回玩家允许的最大离线时间
  - setPlayerTtl
```
public CreateRoomRequest setPlayerTtl(long ttl,
                                      TimeUnit unit)
```
    设置玩家允许的最大离线时间，默认为 0 表示玩家一旦断线就自动从房间离开
    
    Parameters:
    
    ttl - 最大离线时间，不能小于 0，如果设置的过大超过了 Game Server 的允许限制会被限制为 Game Server 最大允许值
    
    unit - 最大离线时间单位
    
    Returns:
    
    this
  - getExpectedUserIds
```
public List<String> getExpectedUserIds()
```
    获取房间指定的玩家 ID 列表。这个参数主要用于为某些能加入到房间中的特定玩家「占位」。
    
    Returns:
    
    房间指定的玩家 ID 列表
  - setExpectUsers
```
public CreateRoomRequest setExpectUsers(List<String> expectUsers)
```
    设置房间指定的玩家 ID 列表。这个参数主要用于为某些能加入到房间中的特定玩家「占位」。
    
    Parameters:
    
    expectUsers - 指定的玩家 ID 列表，列表不能为空，不能是 null。expectUsers 参数会拷贝一份后存入请求内，所以本方法返回后再修改 expectUsers 不会影响已存入请求内的列表
    
    Returns:
    
    this
  - isVisible
```
public boolean isVisible()
```
    房间是否可见。默认为可见，即所有玩家都能在大厅上查看、自动匹配到本房间
    
    Returns:
    
    房间是否可见
  - hideRoom
```
public CreateRoomRequest hideRoom()
```
    隐藏房间。设置后只能通过房间名称加入本房间
    
    Returns:
    
    this
  - exposeRoom
```
public CreateRoomRequest exposeRoom()
```
    暴露房间。设置后所有玩家都能在大厅上查看、自动匹配到本房间
    
    Returns:
    
    this
  - getCustomRoomPropertyKeysForLobby
```
public List<String> getCustomRoomPropertyKeysForLobby()
```
    获取用于房间匹配的房间自定义属性键。不在本列表内的房间自定义属性不会用来做房间匹配
    
    Returns:
    
    用于房间匹配的房间自定义属性键
  - setLobbyKeys
```
public CreateRoomRequest setLobbyKeys(List<String> keys)
```
    设置用于房间匹配的房间自定义属性键。不在本列表内的房间自定义属性不会用来做房间匹配
    
    Parameters:
    
    keys - 用于房间匹配的房间自定义属性键，不能为空也不能是 null。keys 参数会拷贝一份后存入请求内，所以本方法返回后再修改 keys 不会影响已存入请求内的键列表
    
    Returns:
    
    this
  - getCustomRoomProperties
```
public PlayObject getCustomRoomProperties()
```
    获取房间自定义属性
    
    Returns:
    
    返回房间自定义属性，是不可变 Map
  - setRoomProperties
```
public CreateRoomRequest setRoomProperties(PlayObject attr)
```
    设置房间自定义属性
    
    Parameters:
    
    attr - 房间自定义属性，不能是空也不能是 null。attr 会被拷贝一份后存入请求内，所以本方法返回后再修改 attr 不会影响已存入请求内的房间自定义属性参数
    
    Returns:
    
    this
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CreateRoomRequest

Constructor Summary

Method Summary

Methods inherited from class cn.leancloud.play.plugin.request.AbstractRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateRoomRequest

Method Detail

getMaxPlayerCount

setMaxPlayerCount

getEmptyRoomTtlSecs

setEmptyRoomTtl

getPlayerTtlSecs

setPlayerTtl

getExpectedUserIds

setExpectUsers

isVisible

hideRoom

exposeRoom

getCustomRoomPropertyKeysForLobby

setLobbyKeys

getCustomRoomProperties

setRoomProperties

toString