服务端 API

Tiaoom 类是服务端逻辑的主要入口点。此外，服务端还扩展了 Room 和 Player 类以提供游戏逻辑支持。

Tiaoom

构造函数

constructor(options: ITiaoomOptions)

参数	类型	描述
options	ITiaoomOptions	初始化选项。

方法

run()

启动游戏引擎并设置事件监听器。

返回: this

on(event: TiaoomEvents, listener: Function): this

监听服务器事件。

参数	类型	描述
event	keyof TiaoomEvents	事件名称。
listener	Function	事件回调函数。

返回: this

emit(event: TiaoomEvents, ...args: any[]): boolean

触发服务器事件。

参数	类型	描述
event	keyof TiaoomEvents	事件名称。
args	any[]	事件参数。

返回: boolean

searchPlayer(player: string | PlayerOptions | IRoomPlayerOptions): Player | undefined

搜索玩家。

参数	类型	描述
player	string | PlayerOptions | IRoomPlayerOptions	玩家 ID 或玩家选项对象。

返回: Player | undefined

searchRoom(room: string | Partial<IRoomOptions>): Room | undefined

搜索房间。

参数	类型	描述
room	string | Partial<IRoomOptions>	房间 ID 或房间选项对象。

返回: Room | undefined

createRoom(sender: IPlayer, options: IRoomOptions): Room

创建一个新房间。

参数	类型	描述
sender	IPlayer	创建房间的玩家。
options	IRoomOptions	房间选项。

返回: Room

startRoom(sender: IPlayer, room: IRoom): boolean

开始房间游戏。

参数	类型	描述
sender	IPlayer	发起操作的玩家。
room	IRoom	要开始的房间。

返回: boolean

closeRoom(sender: IPlayer, room: IRoom): Room

关闭房间。

参数	类型	描述
sender	IPlayer	发起操作的玩家（必须是房主）。
room	IRoom	要关闭的房间。

返回: Room

kickPlayer(sender: IPlayer, data: { roomId: string, playerId: string }): IRoomPlayer | undefined

将玩家踢出房间。

参数	类型	描述
sender	IPlayer	发起操作的玩家（必须是房主）。
data	{ roomId: string, playerId: string }	包含房间 ID 和目标玩家 ID 的对象。

返回: IRoomPlayer | undefined

transferOwner(sender: IPlayer, data: { roomId: string, playerId: string }): Room | undefined

转让房主权限。

参数	类型	描述
sender	IPlayer	发起操作的玩家（必须是房主）。
data	{ roomId: string, playerId: string }	包含房间 ID 和目标玩家 ID 的对象。

返回: Room | undefined

loginPlayer(player: PlayerOptions, cb?: (data: { player: Player }) => void): Player

玩家登录。

参数	类型	描述
player	PlayerOptions	玩家选项。
cb	(data: { player: Player }) => void (可选)	回调函数。

返回: Player

joinPlayer(sender: IPlayer, player: IRoomPlayerOptions, isCreator?: boolean): IRoomPlayer | undefined

玩家加入房间。

参数	类型	描述
sender	IPlayer	发起操作的玩家。
player	IRoomPlayerOptions	加入房间的选项。
isCreator	boolean (可选)	是否作为房主加入（默认为 false）。

返回: IRoomPlayer | undefined

leavePlayer(sender: IPlayer, player: IRoomPlayerOptions): IRoomPlayer | undefined

玩家离开房间。

参数	类型	描述
sender	IPlayer	发起操作的玩家。
player	IRoomPlayerOptions	离开房间的选项。

返回: IRoomPlayer | undefined

readyPlayer(sender: IPlayer, player: IRoomPlayer): this

玩家准备。

参数	类型	描述
sender	IPlayer	发起操作的玩家。
player	IRoomPlayer	玩家对象。

返回: this

unReadyPlayer(sender: IPlayer, player: IRoomPlayer): this

玩家取消准备。

参数	类型	描述
sender	IPlayer	发起操作的玩家。
player	IRoomPlayer	玩家对象。

返回: this

removePlayer(sender: IPlayer): Player | undefined

移除玩家（完全登出）。

参数	类型	描述
sender	IPlayer	要移除的玩家。

返回: Player | undefined

事件

请参考 事件文档。

Room

服务端房间类，继承自 EventEmitter 并实现了 IRoom 接口。

方法

on(event: RoomEvents, listener: Function): this

监听房间事件。

参数	类型	描述
event	keyof RoomEvents	事件名称。
listener	Function	事件回调函数。

返回: this

emit(event: RoomEvents, ...args: any[]): boolean

触发房间事件。

参数	类型	描述
event	keyof RoomEvents	事件名称。
args	any[]	事件参数。

返回: boolean

setCreator(player: Player): this

设置房主。

参数	类型	描述
player	Player	目标玩家。

返回: this

addPlayer(player: Player, isCreator?: boolean): RoomPlayer

添加玩家到房间。

参数	类型	描述
player	Player	要添加的玩家。
isCreator	boolean (可选)	是否设为房主。

返回: RoomPlayer

kickPlayer(player: IPlayer | string): RoomPlayer

从房间踢出玩家。

参数	类型	描述
player	IPlayer | string	玩家对象或玩家 ID。

返回: RoomPlayer

searchPlayer(player: IPlayer | string): RoomPlayer | undefined

在房间内搜索玩家。

参数	类型	描述
player	IPlayer | string	玩家对象或玩家 ID。

返回: RoomPlayer | undefined

start(): boolean

开始游戏。

返回: boolean (是否有监听器被触发)

end(): boolean

结束游戏。

返回: boolean (是否有监听器被触发)

setSender(sender: (type: string, ...message: any) => void): this

设置房间的消息发送器。⚠️ 内部调用，一般不要使用。

参数	类型	描述
sender	Function	发送函数。

返回: this

属性 (Getters)

• validPlayers: RoomPlayer[] - 有效玩家列表（非旁观者）。
• watchers: RoomPlayer[] - 旁观者列表。
• owner: RoomPlayer | undefined - 房主玩家。
• isReady: boolean - 房间是否已准备好（人数满足且所有玩家已准备）。
• status: RoomStatus - 房间状态。
• isPlaying: boolean - 是否正在游戏中。
• isFull: boolean - 房间是否已满。

Player

服务端玩家类，继承自 EventEmitter 并实现了 IPlayer 接口。

方法

on(event: PlayerEvents, listener: Function): this

监听玩家事件。

参数	类型	描述
event	keyof PlayerEvents	事件名称。
listener	Function	事件回调函数。

返回: this

emit(event: PlayerEvents, ...args: any[]): boolean

触发玩家事件。

参数	类型	描述
event	keyof PlayerEvents	事件名称。
args	any[]	事件参数。

返回: boolean

setSender(sender: (type: string, ...message: any) => void): this

设置玩家的消息发送器。⚠️ 内部调用，一般不要使用。

参数	类型	描述
sender	Function	发送函数。

返回: this