程序包 com.iohao.game.widget.light.room

接口 Room

所有超级接口:
Serializable
所有已知实现类:
SimpleRoom
public interface Room extends Serializable
房间接口
从以下版本开始:
21.8
作者:
渔民小镇
日期:
2022-03-31

  • 方法详细资料

    • getPlayerMap

      Map<Long,Player> getPlayerMap()
      玩家，包含 Robot 
           key : userId
     value : player
      返回:
      玩家

    • getRealPlayerMap

      default Map<Long,Player> getRealPlayerMap()
      所有真实的玩家 
           key : userId
     value : player
      返回:
      真实的玩家
      从以下版本开始:
      21.23

    • getRobotMap

      default Map<Long,Player> getRobotMap()
      所有 Robot 
           key : userId
     value : player
      返回:
      Robot Map
      从以下版本开始:
      21.23

    • getPlayerSeatMap

      Map<Integer,Long> getPlayerSeatMap()
      玩家位置 
           key : seat
     value : userId
      返回:
      玩家位置

    • getRoomId

      long getRoomId()
      get roomId
      返回:
      房间唯一 id

    • setRoomId

      void setRoomId(long roomId)
      set roomId
      参数:
      roomId - 房间唯一 id

    • getSpaceSize

      int getSpaceSize()
      get 房间空间大小
      返回:
      房间空间大小。如 4 就是 4 个人上限 (可以根据规则设置)

    • setSpaceSize

      void setSpaceSize(int spaceSize)
      set 房间空间大小
      参数:
      spaceSize - 房间空间大小。如 4 就是 4 个人上限 (可以根据规则设置)

    • getRoomStatusEnum

      @Deprecated RoomStatusEnum getRoomStatusEnum()
      已过时。
      Developers should define room states themselves.
      get 房间状态
      返回:
      房间状态

    • setRoomStatusEnum

      @Deprecated void setRoomStatusEnum(RoomStatusEnum roomStatusEnum)
      已过时。
      Developers should define room states themselves.
      set 房间状态
      参数:
      roomStatusEnum - 房间状态

    • getRoomCreateContext

      RoomCreateContext getRoomCreateContext()
      get 创建房间信息（及玩法规则）
      返回:
      创建房间信息（及玩法规则）

    • setRoomCreateContext

      void setRoomCreateContext(RoomCreateContext roomCreateContext)
      设置创建房间信息（及玩法规则）
      参数:
      roomCreateContext - 创建房间信息（及玩法规则）

    • getCreatorUserId

      default long getCreatorUserId()
      房间创建者的 userId
      返回:
      userId

    • isCreatorUserId

      default boolean isCreatorUserId(long userId)
      当前 userId 是否是房间创建者
      参数:
      userId - userId
      返回:
      true 是房间创建者

    • listPlayer

      default <T extends Player> Collection<T> listPlayer()
      玩家列表: 所有玩家，包含 Robot
      类型参数:
      T - 玩家
      返回:
      所有玩家

    • streamPlayer

      default <T extends Player> Stream<T> streamPlayer()
      steam players
      返回:
      player Stream

    • listRealPlayer

      default <T extends Player> Collection<T> listRealPlayer()
      真实玩家列表: 所有的真实玩家（不包含 Robot）
      类型参数:
      T - 玩家
      返回:
      所有玩家

    • streamRealPlayer

      default <T extends Player> Stream<T> streamRealPlayer()
      steam real players （真实的玩家）
      返回:
      player Stream

    • listRobot

      default <T extends Player> Collection<T> listRobot()
      RobotList
      类型参数:
      T - Robot
      返回:
      RobotList

    • streamRobot

      default <T extends Player> Stream<T> streamRobot()
      steam players
      返回:
      player Stream

    • listPlayerId

      default Collection<Long> listPlayerId()
      userId Collection
      返回:
      userId

    • listRealPlayerId

      default Collection<Long> listRealPlayerId()
      Robot UserId Collection
      返回:
      userId

    • listRobotPlayerId

      default Collection<Long> listRobotPlayerId()
      Robot UserId Collection
      返回:
      userId

    • getPlayerById

      default <T extends Player> T getPlayerById(long userId)
      通过 userId 查找玩家
      类型参数:
      T - Player
      参数:
      userId - userId
      返回:
      玩家

    • existUser

      default boolean existUser(long userId)
      玩家是否存在房间内
      参数:
      userId - userId
      返回:
      true 存在

    • getPlayerBySeat

      default <T extends Player> T getPlayerBySeat(int seat)
      通过 seat 查找玩家
      类型参数:
      T - Player
      参数:
      seat - seat
      返回:
      玩家

    • addPlayer

      default void addPlayer(Player player)
      添加玩家到房间内
      参数:
      player - 玩家

    • removePlayer

      default void removePlayer(Player player)
      移除玩家
      参数:
      player - 玩家

    • isStatus

      @Deprecated default boolean isStatus(RoomStatusEnum roomStatusEnum)
      已过时。
      Developers should define room states themselves.
      当前房间是否是所指定的房间状态
      参数:
      roomStatusEnum - 房间状态
      返回:
      true 是所指定的房间状态

    • ifPlayerExist

      default <T extends Player> void ifPlayerExist(long userId, Consumer<T> action)
      如果玩家在房间内，就执行给定的操作，否则不执行任何操作。
      类型参数:
      T - t
      参数:
      userId - userId
      action - 给定操作

    • ifPlayerNotExist

      default void ifPlayerNotExist(long userId, Runnable runnable)
      如果玩家不在房间内，就执行给定的操作，否则不执行任何操作。
      参数:
      userId - userId
      runnable - 给定操作

    • countPlayer

      default int countPlayer()
      统计房间内的玩家数量，包含机器人
      返回:
      玩家数量

    • countRealPlayer

      default int countRealPlayer()
      统计房间内真实玩家的数量
      返回:
      真实玩家的数量

    • countRobot

      default int countRobot()
      统计房间内 Robot 的数量
      返回:
      Robot 数量

    • isEmptyPlayer

      default boolean isEmptyPlayer()
      房间内是否没有玩家，包含 Robot
      返回:
      true 房间内没有任何玩家

    • isEmptyRealPlayer

      default boolean isEmptyRealPlayer()
      房间内是否没有真实的玩家
      返回:
      true 房间内没有真实玩家

    • isEmptyRobot

      default boolean isEmptyRobot()
      房间内是否没有 Robot
      返回:
      true 房间内没有 Robot

    • isRobot

      default boolean isRobot(long userId)
      是否 Robot
      参数:
      userId - userId
      返回:
      true: Robot
      从以下版本开始:
      21.23

    • isRealPlayer

      default boolean isRealPlayer(long userId)
      是否真实玩家
      参数:
      userId - userId
      返回:
      true: real player
      从以下版本开始:
      21.23

    • getEmptySeatNo

      default int getEmptySeatNo()
      得到一个空位置
      返回:
      >=0 表示有位置

    • hasSeat

      default boolean hasSeat()
      是否还有空位
      返回:
      true 还有空的位置
      从以下版本开始:
      21.23

    • isReadyPlayers

      default boolean isReadyPlayers()
      玩家是否都准备了
      返回:
      true 所有玩家都准备了

    • forEach

      default void forEach(BiConsumer<Long,Player> action)
      forEach players 
           the first argument is the userId
      参数:
      action - action

    • executeTask

      default void executeTask(Runnable task)
      Executed in domain events, this method is thread-safe
      参数:
      task - task
      从以下版本开始:
      21.23

    • executeDelayTask

      default void executeDelayTask(Runnable task, long delayMilliseconds)
      Delayed execution of tasks, this method is thread-safe
      参数:
      task - task
      delayMilliseconds - delayMilliseconds
      从以下版本开始:
      21.23

    • setOperationService

      default void setOperationService(OperationService operationService)
      setOperationService
      参数:
      operationService - operationService
      从以下版本开始:
      21.28

    • getOperationService

      default OperationService getOperationService()
      getOperationService
      返回:
      OperationService
      从以下版本开始:
      21.28

    • getOperationHandler

      default OperationHandler getOperationHandler(OperationCode operationCode)
      get OperationHandler by OperationCode
      参数:
      operationCode - operationCode
      返回:
      OperationHandler
      从以下版本开始:
      21.28

    • ofOperationContext

      default OperationContext ofOperationContext(OperationHandler operationHandler)
      create OperationContext
      参数:
      operationHandler - operationHandler
      返回:
      OperationContext operationHandler
      从以下版本开始:
      21.23

    • operation

      default void operation(OperationCode operationCode)
      execute operation
      参数:
      operationCode - operationCode
      从以下版本开始:
      21.28

    • operation

      default void operation(OperationCode operationCode, long userId)
      execute operation
      参数:
      operationCode - operationCode
      userId - userId
      从以下版本开始:
      21.28

    • operation

      default void operation(OperationCode operationCode, long userId, Object commandMessage)
      execute operation
      参数:
      operationCode - operationCode
      userId - userId
      commandMessage - commandMessage
      从以下版本开始:
      21.28

    • operation

      default void operation(OperationCode operationCode, FlowContext flowContext)
      execute operation
      参数:
      operationCode - operationCode
      flowContext - flowContext
      从以下版本开始:
      21.28

    • operation

      default void operation(OperationCode operationCode, FlowContext flowContext, Object commandMessage)
      execute operation
      参数:
      operationCode - operationCode
      flowContext - flowContext
      commandMessage - commandMessage
      从以下版本开始:
      21.28

    • operation

      default void operation(OperationHandler operationHandler, long userId, Object commandMessage)
      execute operation
      参数:
      operationHandler - operationHandler
      userId - userId
      commandMessage - commandMessage
      从以下版本开始:
      21.28

    • operation

      default void operation(OperationHandler operationHandler, FlowContext flowContext, Object commandMessage)
      execute operation
      参数:
      operationHandler - operationHandler
      flowContext - flowContext
      commandMessage - commandMessage
      从以下版本开始:
      21.28

    • broadcastToUser

      default void broadcastToUser(CmdInfo cmdInfo, long userId, Object data)
      Broadcast data to a specific user.
      参数:
      cmdInfo - cmdInfo
      userId - userId
      data - data
      从以下版本开始:
      21.28

    • broadcastToUser

      default void broadcastToUser(CmdInfo cmdInfo, long userId)
      Broadcast data to a specific user.
      参数:
      cmdInfo - cmdInfo
      userId - userId
      从以下版本开始:
      21.28

    • broadcastRange

      default void broadcastRange(CmdInfo cmdInfo, Object data, long excludeUserId)
      Broadcast data, excluding specified players.
      参数:
      cmdInfo - cmdInfo
      data - data
      excludeUserId - excludeUserId
      从以下版本开始:
      21.28

    • broadcastRange

      default void broadcastRange(CmdInfo cmdInfo, Object data)
      Broadcast data
      参数:
      cmdInfo - cmdInfo
      data - data
      从以下版本开始:
      21.28

    • broadcastRangeEmpty

      default void broadcastRangeEmpty(CmdInfo cmdInfo, long excludeUserId)
      Broadcast, excluding specified players.
      参数:
      cmdInfo - cmdInfo
      excludeUserId - excludeUserId
      从以下版本开始:
      21.28

    • broadcastRangeEmpty

      default void broadcastRangeEmpty(CmdInfo cmdInfo)
      Broadcast
      参数:
      cmdInfo - cmdInfo
      从以下版本开始:
      21.28

    • setAggregationContext

      void setAggregationContext(CommunicationAggregationContext aggregationContext)
      设置通讯上下文 
      
 // 方式一：通过 flowContext 得到通讯上下文
 CommunicationAggregationContext aggregationContext = flowContext.option(FlowAttr.aggregationContext);
 // 方式二：通过 BrokerClient 得到通讯上下文
 CommunicationAggregationContext aggregationContext = BrokerClientHelper.getBrokerClient().getCommunicationAggregationContext();
      参数:
      aggregationContext - 通讯上下文

    • getAggregationContext

      CommunicationAggregationContext getAggregationContext()
      get 通讯上下文
      返回:
      通讯上下文

    • ofRangeBroadcast

      default RangeBroadcaster ofRangeBroadcast(CommunicationAggregationContext aggregationContext)
      通过 CommunicationAggregationContext 创建一个 RangeBroadcast，默认会添加上当前房间内的所有玩家
      参数:
      aggregationContext - aggregationContext
      返回:
      RangeBroadcast 范围内的广播

    • ofEmptyRangeBroadcast

      default RangeBroadcaster ofEmptyRangeBroadcast(CommunicationAggregationContext aggregationContext)
      通过 CommunicationAggregationContext 创建一个 RangeBroadcast
      参数:
      aggregationContext - aggregationContext
      返回:
      RangeBroadcast 范围内的广播

    • ofRangeBroadcast

      default RangeBroadcaster ofRangeBroadcast()
      创建一个 RangeBroadcast，默认会添加上当前房间内的所有玩家
      返回:
      RangeBroadcast 范围内的广播

    • ofEmptyRangeBroadcast

      default RangeBroadcaster ofEmptyRangeBroadcast()
      创建一个 RangeBroadcast
      返回:
      RangeBroadcast 范围内的广播