From 987a0cb91abf4bf703cfaa2e1b2515cf58d7e281 Mon Sep 17 00:00:00 2001 From: szdytom Date: Sat, 10 Feb 2024 19:52:46 +0800 Subject: [PATCH] [server] updated doc --- docs/server.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/server.md b/docs/server.md index f8957d2..08ebf45 100644 --- a/docs/server.md +++ b/docs/server.md @@ -312,6 +312,22 @@ | `sender` | `uuid` | 发送消息的主体 | | `msg` | `str` | 消息内容 | +### 适配器实现的函数 + +| 标识符 | 函数名 | 函数功能 | 函数参数类型名 | 函数返回值类型名 | +| :----- | :----------------------- | :--------------------------------- | :-------------------- | :--------------- | +| 10 | `joinRoom` | 加入房间 | `void` | `void` | +| 11 | `joinTeam` | 加入队伍 | `Team` | `void` | +| 20 | `giveOwner` | 转让房主 | `uuid` | `void` | +| 21 | `setImportMapName` | 设置导入的地图名称 | `str` | `void` | +| 22 | `setRandomTerrianConfig` | 设置随机地图配置 | `RandomTerrianConfig` | `void` | +| 30 | `takeOwner` | 取得房主 | `void` | `void` | +| 40 | `requestStart` | 开始游戏 | `void` | `void` | +| 50 | `appendOrderQueue` | 向玩家的行动队列的末尾添加一个移动 | `PlayerMove` | `void` | +| 51 | `clearMoveQueue` | 清空玩家的行动队列 | `void` | `void` | +| 52 | `popOrderQueue` | 清除玩家的行动队列的最后一项 | `void` | `void` | +| 53 | `surrender` | 投降 | `void` | `void` | + ## 用户账户与认证 用户账户是玩家身份的表示，每个用户账户拥有一个唯一的用户登录名和一个唯一的用户全局唯一标识符。用户登录名一旦设置则不可更改。登录名的字符集限制为大小写字母、数字和下划线的组合。用户的全局唯一标识符使用 UUID V5 生成（遵循 RFC 4122）。每个用户还有一个用户显示名，用于在页面各处展示，该名称可以修改，且不设置字符集限制，使用 UTF-8 编码。