From 7306c0d8b6be58d405876430999bd9ab99f46b76 Mon Sep 17 00:00:00 2001 From: kercylan98 Date: Fri, 19 May 2023 09:49:53 +0800 Subject: [PATCH] =?UTF-8?q?=E6=B3=A8=E9=87=8A=E4=BC=98=E5=8C=96?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- game/builtin/room.go | 27 +++++++++++++++++++++++++-- game/builtin/room_options.go | 4 ++-- 2 files changed, 27 insertions(+), 4 deletions(-) diff --git a/game/builtin/room.go b/game/builtin/room.go index 12fcac0..4acb17b 100644 --- a/game/builtin/room.go +++ b/game/builtin/room.go @@ -8,6 +8,7 @@ import ( "go.uber.org/zap" ) +// NewRoom 创建一个默认的内置游戏房间 Room func NewRoom[PlayerID comparable, Player game.Player[PlayerID]](guid int64, options ...RoomOption[PlayerID, Player]) *Room[PlayerID, Player] { room := &Room[PlayerID, Player]{ guid: guid, @@ -19,47 +20,60 @@ func NewRoom[PlayerID comparable, Player game.Player[PlayerID]](guid int64, opti return room } +// Room 默认的内置游戏房间实现 +// - 实现了最大人数控制、房主、踢出玩家、玩家维护等功能 +// - 支持并发安全和非并发安全的模式 type Room[PlayerID comparable, Player game.Player[PlayerID]] struct { guid int64 owner PlayerID noMaster bool playerLimit int players hash.Map[PlayerID, Player] - kickCheckHandle func(id, target PlayerID) error + kickCheckHandle func(room *Room[PlayerID, Player], id, target PlayerID) error playerJoinRoomEventHandles []game.PlayerJoinRoomEventHandle[PlayerID, Player] playerLeaveRoomEventHandles []game.PlayerLeaveRoomEventHandle[PlayerID, Player] playerKickedOutEventHandles []game.PlayerKickedOutEventHandle[PlayerID, Player] } +// GetGuid 获取房间唯一标识 func (slf *Room[PlayerID, Player]) GetGuid() int64 { return slf.guid } +// GetPlayerLimit 获取最大玩家上限 func (slf *Room[PlayerID, Player]) GetPlayerLimit() int { return slf.playerLimit } +// GetPlayer 根据玩家id获取玩家 func (slf *Room[PlayerID, Player]) GetPlayer(id PlayerID) Player { return slf.players.Get(id) } +// GetPlayers 获取所有玩家 func (slf *Room[PlayerID, Player]) GetPlayers() hash.MapReadonly[PlayerID, Player] { return slf.players.(hash.MapReadonly[PlayerID, Player]) } +// GetPlayerCount 获取玩家数量 func (slf *Room[PlayerID, Player]) GetPlayerCount() int { return slf.players.Size() } +// IsExistPlayer 房间内是否存在某玩家 func (slf *Room[PlayerID, Player]) IsExistPlayer(id PlayerID) bool { return slf.players.Exist(id) } +// IsOwner 检查特定玩家是否是房主 +// - 当房间为无主模式(WithRoomNoMaster)时，将会始终返回false func (slf *Room[PlayerID, Player]) IsOwner(id PlayerID) bool { return !slf.noMaster && slf.owner == id } +// ChangeOwner 改变房主 +// - 当房间为无主模式(WithRoomNoMaster)时，将不会发生任何变化 func (slf *Room[PlayerID, Player]) ChangeOwner(id PlayerID) { if slf.noMaster || slf.owner == id { return @@ -67,6 +81,7 @@ func (slf *Room[PlayerID, Player]) ChangeOwner(id PlayerID) { slf.owner = id } +// Join 控制玩家加入到该房间 func (slf *Room[PlayerID, Player]) Join(player Player) error { if slf.players.Size() >= slf.playerLimit && slf.playerLimit > 0 { return ErrRoomPlayerLimit @@ -80,6 +95,7 @@ func (slf *Room[PlayerID, Player]) Join(player Player) error { return nil } +// Leave 控制玩家离开房间 func (slf *Room[PlayerID, Player]) Leave(id PlayerID) { player, exist := slf.players.GetExist(id) if !exist { @@ -90,13 +106,17 @@ func (slf *Room[PlayerID, Player]) Leave(id PlayerID) { slf.players.Delete(player.GetID()) } +// KickOut 以某种原因踢出特定玩家 +// - 当设置了房间踢出玩家的检查处理函数(WithRoomKickPlayerCheckHandle)时，将会根据检查结果进行处理，即便是无主模式。其他情况如下 +// - 如果是无主模式(WithRoomNoMaster)，将会返回错误 +// - 如果不是房主发起的踢出玩家，将会返回错误 func (slf *Room[PlayerID, Player]) KickOut(id, target PlayerID, reason string) error { player, exist := slf.players.GetExist(target) if !exist { return nil } if slf.kickCheckHandle != nil { - if err := slf.kickCheckHandle(id, target); err != nil { + if err := slf.kickCheckHandle(slf, id, target); err != nil { return err } } else if slf.noMaster { @@ -110,6 +130,7 @@ func (slf *Room[PlayerID, Player]) KickOut(id, target PlayerID, reason string) e return nil } +// RegPlayerJoinRoomEvent 玩家进入房间时将立即执行被注册的事件处理函数 func (slf *Room[PlayerID, Player]) RegPlayerJoinRoomEvent(handle game.PlayerJoinRoomEventHandle[PlayerID, Player]) { slf.playerJoinRoomEventHandles = append(slf.playerJoinRoomEventHandles, handle) } @@ -120,6 +141,7 @@ func (slf *Room[PlayerID, Player]) OnPlayerJoinRoomEvent(player Player) { } } +// RegPlayerLeaveRoomEvent 玩家离开房间时将立即执行被注册的事件处理函数 func (slf *Room[PlayerID, Player]) RegPlayerLeaveRoomEvent(handle game.PlayerLeaveRoomEventHandle[PlayerID, Player]) { slf.playerLeaveRoomEventHandles = append(slf.playerLeaveRoomEventHandles, handle) } @@ -130,6 +152,7 @@ func (slf *Room[PlayerID, Player]) OnPlayerLeaveRoomEvent(player Player) { } } +// RegPlayerKickedOutEvent 当玩家被踢出游戏时将立即执行被注册的事件处理函数 func (slf *Room[PlayerID, Player]) RegPlayerKickedOutEvent(handle game.PlayerKickedOutEventHandle[PlayerID, Player]) { slf.playerKickedOutEventHandles = append(slf.playerKickedOutEventHandles, handle) } diff --git a/game/builtin/room_options.go b/game/builtin/room_options.go index 69b0242..0b9801d 100644 --- a/game/builtin/room_options.go +++ b/game/builtin/room_options.go @@ -29,9 +29,9 @@ func WithRoomNoMaster[PlayerID comparable, Player game.Player[PlayerID]]() RoomO } } -// WithRoomKickPlayerCheckHandle 设置房间提出玩家的检查处理函数 +// WithRoomKickPlayerCheckHandle 设置房间踢出玩家的检查处理函数 // - 当没有设置该函数时，如果不是房主，将无法进行踢出 -func WithRoomKickPlayerCheckHandle[PlayerID comparable, Player game.Player[PlayerID]](handle func(id, target PlayerID) error) RoomOption[PlayerID, Player] { +func WithRoomKickPlayerCheckHandle[PlayerID comparable, Player game.Player[PlayerID]](handle func(room *Room[PlayerID, Player], id, target PlayerID) error) RoomOption[PlayerID, Player] { return func(room *Room[PlayerID, Player]) { room.kickCheckHandle = handle }