tiaoom 0.0.11 → 0.0.12

package/src/index.d.cts

@@ -26,18 +26,6 @@ interface BaseEvents {
  * 玩家事件定义
  */
 interface PlayerEvents extends BaseEvents {
-  /**
-   * 加入房间
-   * @param {Room} room 房间信息
-   * @param {Player} player 玩家信息
-   **/
-  join: (room: Room, player: Player) => void;
-  /**
-   * 离开房间
-   * @param {Room} room 房间信息
-   * @param {Player} player 玩家信息
-   **/
-  leave: (room: Room, player: Player) => void;
   /**
    * 玩家状态变化
    * @param {PlayerStatus} status 玩家状态
@@ -45,9 +33,9 @@ interface PlayerEvents extends BaseEvents {
   status: (status: PlayerStatus) => void;
   /**
    * 玩家命令
-   * @param {MessagePackage} message 命令内容
+   * @param {IMessagePackage} message 命令内容
    */
-  command: (message: MessagePackage) => void;
+  command: (message: any) => void;
   /**
    * 玩家私信
    * @param {string} data 消息内容
@@ -60,7 +48,7 @@ interface PlayerEvents extends BaseEvents {
 /**
  * 玩家选项接口
  */
-interface PlayerOptions {
+interface IPlayerOptions {
   /**
    * 玩家ID
    */
@@ -102,7 +90,7 @@ declare enum PlayerStatus {
 /**
  * 玩家接口
  */
-interface IPlayer extends PlayerOptions {
+interface IPlayer extends IPlayerOptions {
   /**
    * 玩家状态
    */
@@ -136,7 +124,7 @@ declare class Player extends EventEmitter$1 implements IPlayer {
     name,
     attributes,
     sender
-  }: PlayerOptions);
+  }: IPlayerOptions);
   toJSON(): {
     id: string;
     name: string;
@@ -155,60 +143,153 @@ declare class Player extends EventEmitter$1 implements IPlayer {
 //#region lib/models/message.d.ts
 /**
  * 消息包类型枚举
+ * player： 'command', 'message', 'join', 'leave', 'status'
  */
 declare enum MessageTypes {
+  /**
+   * 房间列表
+   */
   RoomList = "room.list",
+  /**
+   * 房间创建
+   */
   RoomCreate = "room.create",
+  /**
+   * 房间更新
+   */
+  RoomUpdate = "room.update",
+  /**
+   * 房间准备
+   */
   RoomReady = "room.ready",
+  /**
+   * 房间开始
+   */
   RoomStart = "room.start",
+  /**
+   * 房间结束
+   */
   RoomEnd = "room.end",
+  /**
+   * 房间关闭
+   */
   RoomClose = "room.close",
-  RoomAllReady = "room.allready",
+  /**
+   * 房间全部玩家已准备
+   */
+  RoomAllReady = "room.all-ready",
+  /**
+   * 房间命令
+   */
   RoomCommand = "room.command",
+  /**
+   * 房间消息
+   */
   RoomMessage = "room.message",
-  PlayerOffline = "player.offline",
+  /**
+   * 玩家加入房间
+   */
+  RoomJoin = "room.join",
+  /**
+   * 玩家离开房间
+   */
+  RoomLeave = "room.leave",
+  /**
+   * 房间踢出玩家
+   */
+  RoomKick = "room.kick",
+  /**
+   * 房间转移
+   */
+  RoomTransfer = "room.transfer",
+  /**
+   * 房间玩家准备
+   */
+  RoomPlayerReady = "room.player-ready",
+  /**
+   * 房间玩家取消准备
+   */
+  RoomPlayerUnready = "room.player-unready",
+  /**
+   * 玩家列表
+   */
   PlayerList = "player.list",
+  /**
+   * 玩家登录
+   */
   PlayerLogin = "player.login",
+  /**
+   * 玩家登出
+   */
   PlayerLogout = "player.logout",
-  PlayerJoin = "player.join",
-  PlayerLeave = "player.leave",
+  /**
+   * 玩家消息
+   */
+  PlayerMessage = "player.message",
+  /**
+   * 玩家命令
+   */
+  PlayerCommand = "player.command",
+  /**
+   * 玩家准备
+   */
   PlayerReady = "player.ready",
+  /**
+   * 玩家取消准备
+   */
   PlayerUnready = "player.unready",
-  PlayerCommand = "player.command",
+  /**
+   * 全局命令
+   */
+  GlobalCommand = "global.command",
+  /**
+   * 全局消息
+   */
+  GlobalMessage = "global.message",
+  /**
+   * 全局错误
+   */
+  GlobalError = "global.error",
 }
 /**
  * 消息包接口
  */
-interface MessagePackage {
+interface IMessagePackage {
   /**
    * 消息类型
    */
-  type: MessageTypes | string;
+  type: MessageTypes;
   /**
    * 消息数据
    */
-  data?: PlayerOptions | IRoomOptions | IPlayer | IRoom | IRoomPlayer | any;
+  data?: IPlayerOptions | IRoomOptions | IPlayer | IRoom | IRoomPlayer | any;
   /**
-   * 消息发送者
+   * 发送者信息
    */
-  sender?: IPlayer | IRoom | IRoomPlayer;
+  sender?: IPlayer | IRoomPlayer | IRoom;
+}
+/**
+ * 消息数据接口，包含发送者信息
+ */
+interface IMessageData extends IMessagePackage {
+  sender: IPlayer | IRoomPlayer | IRoom;
 }
 /**
  * 消息通信接口
  */
-interface Message extends EventEmitter$1 {
+interface IMessage extends EventEmitter$1 {
   /**
    * 监听消息事件
    * @param event 事件名，具体见 MessageEvents
    * @param listener 监听器
    */
-  on<K extends keyof MessageEvents>(event: K, listener: MessageEvents[K]): this;
+  on<K extends keyof IMessageEvents>(event: K, listener: IMessageEvents[K]): this;
   /**
    * 触发消息事件
    * @param event 事件名，具体见 MessageEvents
    * @param args 参数
    */
-  emit<K extends keyof MessageEvents>(event: K, ...args: Parameters<MessageEvents[K]>): boolean;
+  emit<K extends keyof IMessageEvents>(event: K, ...args: Parameters<IMessageEvents[K]>): boolean;
   /**
    * 关闭连接
    */
@@ -217,20 +298,20 @@ interface Message extends EventEmitter$1 {
    * 发送消息包
    * @param message 消息包
    */
-  send(message: MessagePackage): void;
+  send(message: IMessagePackage): void;
 }
 //#endregion
 //#region lib/events/message.d.ts
 /**
  * 消息事件定义
  */
-interface MessageEvents extends BaseEvents {
+interface IMessageEvents extends BaseEvents {
   /**
    * 服务接收数据
-   * @param {MessagePackage} data 消息数据
+   * @param {IMessagePackage} data 消息数据
    * @param {(...params:any) => any} [cb] 回调函数
    */
-  message: (data: MessagePackage, cb?: (...params: any) => any) => void;
+  message: (data: IMessageData, cb?: (...params: any) => any) => void;
 }
 //#endregion
 //#region lib/events/room.d.ts
@@ -260,14 +341,14 @@ interface RoomEvents extends BaseEvents {
   message: (data: string) => void;
   /**
    * 玩家发送的房间命令
-   * @param {MessagePackage} message 命令内容
+   * @param {IMessagePackage} message 命令内容
    */
-  'player-command': (message: MessagePackage) => void;
+  'player-command': (message: IMessagePackage) => void;
   /**
    * 房间命令
-   * @param {MessagePackage} message 命令内容
+   * @param {IMessagePackage} message 命令内容
    */
-  command: (message: MessagePackage) => void;
+  command: (message: any) => void;
   /**
    * 房间更新
    * @param {IRoom} room 房间信息
@@ -292,7 +373,7 @@ interface RoomEvents extends BaseEvents {
    * 房间开始游戏
    * @param {IRoom} room 房间信息
    */
-  start: (room: IRoom) => void;
+  start: (room: IRoom, sender: IRoomPlayer) => void;
   /**
    * 房间结束游戏
    * @param {IRoom} room 房间信息
@@ -408,7 +489,7 @@ interface IRoom extends IRoomOptions {
 /**
  * 房间玩家选项接口
  */
-interface IRoomPlayerOptions extends PlayerOptions {
+interface IRoomPlayerOptions extends IPlayerOptions {
   /**
    * 房间Id
    */
@@ -559,7 +640,7 @@ declare class Room extends EventEmitter$1 implements IRoom {
   /**
    * 开始游戏
    */
-  start(): boolean;
+  start(sender: IPlayer): boolean;
   /**
    * 结束游戏
    */
@@ -573,12 +654,12 @@ declare class Room extends EventEmitter$1 implements IRoom {
 //#endregion
 //#region lib/index.d.ts
 interface ITiaoomOptions {
-  socket: Message;
+  socket: IMessage;
 }
 declare class Tiaoom extends EventEmitter {
   rooms: Room[];
   players: Player[];
-  messageInstance?: Message;
+  messageInstance?: IMessage;
   constructor({
     socket
   }: ITiaoomOptions);
@@ -586,7 +667,7 @@ declare class Tiaoom extends EventEmitter {
   emit<K extends keyof TiaoomEvents>(event: K, ...args: Parameters<TiaoomEvents[K]>): boolean;
   run(): this;
   searchPlayer(player: string): Player | undefined;
-  searchPlayer(player: PlayerOptions | IRoomPlayerOptions): Player | undefined;
+  searchPlayer(player: IPlayerOptions | IRoomPlayerOptions): Player | undefined;
   searchRoom(room: string): Room | undefined;
   searchRoom(room: Partial<IRoomOptions>): Room | undefined;
   createRoom(sender: IPlayer, options: IRoomOptions): Room;
@@ -600,7 +681,7 @@ declare class Tiaoom extends EventEmitter {
     roomId: string;
     playerId: string;
   }): Room | undefined;
-  loginPlayer(player: PlayerOptions, cb?: (data: {
+  loginPlayer(player: IPlayerOptions, cb?: (data: {
     player: Player;
   }) => void): Player;
   joinPlayer(sender: IPlayer, player: IRoomPlayerOptions, isCreator?: boolean): RoomPlayer;
@@ -610,5 +691,5 @@ declare class Tiaoom extends EventEmitter {
   removePlayer(sender: IPlayer): Player;
 }
 //#endregion
-export { IPlayer, IRoom, IRoomOptions, IRoomPlayer, IRoomPlayerOptions, ITiaoomOptions, Message, MessageEvents, MessagePackage, MessageTypes, Player, PlayerEvents, PlayerOptions, PlayerRole, PlayerStatus, Room, RoomEvents, RoomPlayer, RoomStatus, Tiaoom, TiaoomEvents };
+export { IMessage, IMessageData, IMessageEvents, IMessagePackage, IPlayer, IPlayerOptions, IRoom, IRoomOptions, IRoomPlayer, IRoomPlayerOptions, ITiaoomOptions, MessageTypes, Player, PlayerEvents, PlayerRole, PlayerStatus, Room, RoomEvents, RoomPlayer, RoomStatus, Tiaoom, TiaoomEvents };
 //# sourceMappingURL=index.d.cts.map

package/src/index.d.mts

@@ -26,18 +26,6 @@ interface BaseEvents {
  * 玩家事件定义
  */
 interface PlayerEvents extends BaseEvents {
-  /**
-   * 加入房间
-   * @param {Room} room 房间信息
-   * @param {Player} player 玩家信息
-   **/
-  join: (room: Room, player: Player) => void;
-  /**
-   * 离开房间
-   * @param {Room} room 房间信息
-   * @param {Player} player 玩家信息
-   **/
-  leave: (room: Room, player: Player) => void;
   /**
    * 玩家状态变化
    * @param {PlayerStatus} status 玩家状态
@@ -45,9 +33,9 @@ interface PlayerEvents extends BaseEvents {
   status: (status: PlayerStatus) => void;
   /**
    * 玩家命令
-   * @param {MessagePackage} message 命令内容
+   * @param {IMessagePackage} message 命令内容
    */
-  command: (message: MessagePackage) => void;
+  command: (message: any) => void;
   /**
    * 玩家私信
    * @param {string} data 消息内容
@@ -60,7 +48,7 @@ interface PlayerEvents extends BaseEvents {
 /**
  * 玩家选项接口
  */
-interface PlayerOptions {
+interface IPlayerOptions {
   /**
    * 玩家ID
    */
@@ -102,7 +90,7 @@ declare enum PlayerStatus {
 /**
  * 玩家接口
  */
-interface IPlayer extends PlayerOptions {
+interface IPlayer extends IPlayerOptions {
   /**
    * 玩家状态
    */
@@ -136,7 +124,7 @@ declare class Player extends EventEmitter$1 implements IPlayer {
     name,
     attributes,
     sender
-  }: PlayerOptions);
+  }: IPlayerOptions);
   toJSON(): {
     id: string;
     name: string;
@@ -155,60 +143,153 @@ declare class Player extends EventEmitter$1 implements IPlayer {
 //#region lib/models/message.d.ts
 /**
  * 消息包类型枚举
+ * player： 'command', 'message', 'join', 'leave', 'status'
  */
 declare enum MessageTypes {
+  /**
+   * 房间列表
+   */
   RoomList = "room.list",
+  /**
+   * 房间创建
+   */
   RoomCreate = "room.create",
+  /**
+   * 房间更新
+   */
+  RoomUpdate = "room.update",
+  /**
+   * 房间准备
+   */
   RoomReady = "room.ready",
+  /**
+   * 房间开始
+   */
   RoomStart = "room.start",
+  /**
+   * 房间结束
+   */
   RoomEnd = "room.end",
+  /**
+   * 房间关闭
+   */
   RoomClose = "room.close",
-  RoomAllReady = "room.allready",
+  /**
+   * 房间全部玩家已准备
+   */
+  RoomAllReady = "room.all-ready",
+  /**
+   * 房间命令
+   */
   RoomCommand = "room.command",
+  /**
+   * 房间消息
+   */
   RoomMessage = "room.message",
-  PlayerOffline = "player.offline",
+  /**
+   * 玩家加入房间
+   */
+  RoomJoin = "room.join",
+  /**
+   * 玩家离开房间
+   */
+  RoomLeave = "room.leave",
+  /**
+   * 房间踢出玩家
+   */
+  RoomKick = "room.kick",
+  /**
+   * 房间转移
+   */
+  RoomTransfer = "room.transfer",
+  /**
+   * 房间玩家准备
+   */
+  RoomPlayerReady = "room.player-ready",
+  /**
+   * 房间玩家取消准备
+   */
+  RoomPlayerUnready = "room.player-unready",
+  /**
+   * 玩家列表
+   */
   PlayerList = "player.list",
+  /**
+   * 玩家登录
+   */
   PlayerLogin = "player.login",
+  /**
+   * 玩家登出
+   */
   PlayerLogout = "player.logout",
-  PlayerJoin = "player.join",
-  PlayerLeave = "player.leave",
+  /**
+   * 玩家消息
+   */
+  PlayerMessage = "player.message",
+  /**
+   * 玩家命令
+   */
+  PlayerCommand = "player.command",
+  /**
+   * 玩家准备
+   */
   PlayerReady = "player.ready",
+  /**
+   * 玩家取消准备
+   */
   PlayerUnready = "player.unready",
-  PlayerCommand = "player.command",
+  /**
+   * 全局命令
+   */
+  GlobalCommand = "global.command",
+  /**
+   * 全局消息
+   */
+  GlobalMessage = "global.message",
+  /**
+   * 全局错误
+   */
+  GlobalError = "global.error",
 }
 /**
  * 消息包接口
  */
-interface MessagePackage {
+interface IMessagePackage {
   /**
    * 消息类型
    */
-  type: MessageTypes | string;
+  type: MessageTypes;
   /**
    * 消息数据
    */
-  data?: PlayerOptions | IRoomOptions | IPlayer | IRoom | IRoomPlayer | any;
+  data?: IPlayerOptions | IRoomOptions | IPlayer | IRoom | IRoomPlayer | any;
   /**
-   * 消息发送者
+   * 发送者信息
    */
-  sender?: IPlayer | IRoom | IRoomPlayer;
+  sender?: IPlayer | IRoomPlayer | IRoom;
+}
+/**
+ * 消息数据接口，包含发送者信息
+ */
+interface IMessageData extends IMessagePackage {
+  sender: IPlayer | IRoomPlayer | IRoom;
 }
 /**
  * 消息通信接口
  */
-interface Message extends EventEmitter$1 {
+interface IMessage extends EventEmitter$1 {
   /**
    * 监听消息事件
    * @param event 事件名，具体见 MessageEvents
    * @param listener 监听器
    */
-  on<K extends keyof MessageEvents>(event: K, listener: MessageEvents[K]): this;
+  on<K extends keyof IMessageEvents>(event: K, listener: IMessageEvents[K]): this;
   /**
    * 触发消息事件
    * @param event 事件名，具体见 MessageEvents
    * @param args 参数
    */
-  emit<K extends keyof MessageEvents>(event: K, ...args: Parameters<MessageEvents[K]>): boolean;
+  emit<K extends keyof IMessageEvents>(event: K, ...args: Parameters<IMessageEvents[K]>): boolean;
   /**
    * 关闭连接
    */
@@ -217,20 +298,20 @@ interface Message extends EventEmitter$1 {
    * 发送消息包
    * @param message 消息包
    */
-  send(message: MessagePackage): void;
+  send(message: IMessagePackage): void;
 }
 //#endregion
 //#region lib/events/message.d.ts
 /**
  * 消息事件定义
  */
-interface MessageEvents extends BaseEvents {
+interface IMessageEvents extends BaseEvents {
   /**
    * 服务接收数据
-   * @param {MessagePackage} data 消息数据
+   * @param {IMessagePackage} data 消息数据
    * @param {(...params:any) => any} [cb] 回调函数
    */
-  message: (data: MessagePackage, cb?: (...params: any) => any) => void;
+  message: (data: IMessageData, cb?: (...params: any) => any) => void;
 }
 //#endregion
 //#region lib/events/room.d.ts
@@ -260,14 +341,14 @@ interface RoomEvents extends BaseEvents {
   message: (data: string) => void;
   /**
    * 玩家发送的房间命令
-   * @param {MessagePackage} message 命令内容
+   * @param {IMessagePackage} message 命令内容
    */
-  'player-command': (message: MessagePackage) => void;
+  'player-command': (message: IMessagePackage) => void;
   /**
    * 房间命令
-   * @param {MessagePackage} message 命令内容
+   * @param {IMessagePackage} message 命令内容
    */
-  command: (message: MessagePackage) => void;
+  command: (message: any) => void;
   /**
    * 房间更新
    * @param {IRoom} room 房间信息
@@ -292,7 +373,7 @@ interface RoomEvents extends BaseEvents {
    * 房间开始游戏
    * @param {IRoom} room 房间信息
    */
-  start: (room: IRoom) => void;
+  start: (room: IRoom, sender: IRoomPlayer) => void;
   /**
    * 房间结束游戏
    * @param {IRoom} room 房间信息
@@ -408,7 +489,7 @@ interface IRoom extends IRoomOptions {
 /**
  * 房间玩家选项接口
  */
-interface IRoomPlayerOptions extends PlayerOptions {
+interface IRoomPlayerOptions extends IPlayerOptions {
   /**
    * 房间Id
    */
@@ -559,7 +640,7 @@ declare class Room extends EventEmitter$1 implements IRoom {
   /**
    * 开始游戏
    */
-  start(): boolean;
+  start(sender: IPlayer): boolean;
   /**
    * 结束游戏
    */
@@ -573,12 +654,12 @@ declare class Room extends EventEmitter$1 implements IRoom {
 //#endregion
 //#region lib/index.d.ts
 interface ITiaoomOptions {
-  socket: Message;
+  socket: IMessage;
 }
 declare class Tiaoom extends EventEmitter {
   rooms: Room[];
   players: Player[];
-  messageInstance?: Message;
+  messageInstance?: IMessage;
   constructor({
     socket
   }: ITiaoomOptions);
@@ -586,7 +667,7 @@ declare class Tiaoom extends EventEmitter {
   emit<K extends keyof TiaoomEvents>(event: K, ...args: Parameters<TiaoomEvents[K]>): boolean;
   run(): this;
   searchPlayer(player: string): Player | undefined;
-  searchPlayer(player: PlayerOptions | IRoomPlayerOptions): Player | undefined;
+  searchPlayer(player: IPlayerOptions | IRoomPlayerOptions): Player | undefined;
   searchRoom(room: string): Room | undefined;
   searchRoom(room: Partial<IRoomOptions>): Room | undefined;
   createRoom(sender: IPlayer, options: IRoomOptions): Room;
@@ -600,7 +681,7 @@ declare class Tiaoom extends EventEmitter {
     roomId: string;
     playerId: string;
   }): Room | undefined;
-  loginPlayer(player: PlayerOptions, cb?: (data: {
+  loginPlayer(player: IPlayerOptions, cb?: (data: {
     player: Player;
   }) => void): Player;
   joinPlayer(sender: IPlayer, player: IRoomPlayerOptions, isCreator?: boolean): RoomPlayer;
@@ -610,5 +691,5 @@ declare class Tiaoom extends EventEmitter {
   removePlayer(sender: IPlayer): Player;
 }
 //#endregion
-export { IPlayer, IRoom, IRoomOptions, IRoomPlayer, IRoomPlayerOptions, ITiaoomOptions, Message, MessageEvents, MessagePackage, MessageTypes, Player, PlayerEvents, PlayerOptions, PlayerRole, PlayerStatus, Room, RoomEvents, RoomPlayer, RoomStatus, Tiaoom, TiaoomEvents };
+export { IMessage, IMessageData, IMessageEvents, IMessagePackage, IPlayer, IPlayerOptions, IRoom, IRoomOptions, IRoomPlayer, IRoomPlayerOptions, ITiaoomOptions, MessageTypes, Player, PlayerEvents, PlayerRole, PlayerStatus, Room, RoomEvents, RoomPlayer, RoomStatus, Tiaoom, TiaoomEvents };
 //# sourceMappingURL=index.d.mts.map