Skip to content

search.md

Latest commit

 

History

History
218 lines (184 loc) · 6.96 KB

search.md

File metadata and controls

218 lines (184 loc) · 6.96 KB

搜索房间接口

搜索房间接口是一系列专门用于根据一定的条件搜索符合条件的房间列表的接口。

数据结构

房间过滤器 RoomFilter

房间过滤器是一个根据实际场景需要对房间进行过滤的数据结构。基本数据结构如下

字段 类型 说明
RoomConditions []object? 匹配房间条件，留空则不过滤
--RoomConditions.Key string 条件的主键
--RoomConditions.Not bool 条件取否
--RoomConditions.Value int 条件值
HasAnyExitTo []string? 出口目标过滤，留空则不过滤
HasAnyGroup []string? 房间分组过滤，留空则不过滤
HasAnyName []string? 完整房间名过滤，留空则不过滤
ContainsAnyName []string? 部分房间名过滤，留空则不过滤
HasAnyData []obecjt? 完整数据值过滤，留空则不过滤
--HasAnyData.Key string 数据主键
--HasAnyData.Value string 数据值，需要完整匹配
ContainsAnyData []objext? 部分数据值过滤，留空则不过滤
--ContainsAnyData.Key string 数据主键
--ContainsAnyData.Value string 数据值，部分匹配
ContainsAnyKey []string? 部分匹配房间主键

所以的字段都是可选的，不设置或者空数组代表不过滤。

所有已经设置的条件必须全部符合。

具体功能为

  • RoomConditions 与房间的Tag进行匹配，必须全部符合
  • HasAnyExitTo 必须具有到指定房间的出口
  • HasAnyGroup 必须具有指定分组过滤，一般用于限制城市.1001版后加入。
  • HasAnyName 根据完整房间名的筛选，可以用来查找是否是唯一的名称的房间
  • ContainsAnyName 查找房间名字，部分匹配即可
  • HasAnyData 匹配含有任何指定房间数据的房间。房间数据必须完整匹配。比如查找描述
  • ContainsAnyData 匹配含有任何指定房间数据的房间。房间数据部分匹配。
  • ContainsAnyKey 匹配房间key部分匹配的房间。一般较少用，除非key有特殊的规律

搜索房间接口 SearchRooms

根据给到的过滤器搜索符合条件的房间

请求地址:

/api/db/searchrooms

请求正文:

字段 类型 说明
Filter RoomFilter 房间过滤器

返回结果：

字段 类型 说明
[]object? 房间
Key string 房间主键
Name string 房间名
Desc string 房间描述
Group string 房间分组
Tags []object 房间标签
--Tags.Key string 标签主键
--Tags.Value int 标签值
Exits []object 房间出口列表
--Exits.Command string 出口指令
--Exits.To string 出口房间
--Exits.Cost int 出口消耗
--Exits.Conditions []object 出口条件列表
--Exits.Conditions.Key string 条件主键
--Exits.Conditions.Not bool 条件取否
--Exits.Conditions.Value int 条件值
Data []object? 房间数据列表
--Data.Key string 数据主键
--Data.Value string 数据值

示例请求

POST http://127.0.0.1:8466/api/db/searchrooms HTTP/1.1

{
    "Filter":{
        "HasAnyName" :["钱庄"]
    }
}

示例结果:

HTTP/1.1 200 OK
Connection: close
Content-Type: application/json; charset=utf-8
Date: Sat, 13 Dec 2025 12:56:30 GMT
Server: HellMapManager
Transfer-Encoding: chunked

[
  {
    "Key": "23",
    "Name": "钱庄",
    "Desc": "",
    "Group": "扬州",
    "Tags": [],
    "Exits": [
      {
        "Command": "e",
        "To": "22",
        "Conditions": [],
        "Cost": 1
      }
    ],
    "Data": []
  },
  {
    "Key": "137",
    "Name": "钱庄",
    "Desc": "",
    "Group": "长安",
    "Tags": [],
    "Exits": [
      {
        "Command": "e",
        "To": "136",
        "Conditions": [],
        "Cost": 1
      }
    ],
    "Data": []
  }
]

过滤房间接口 FilterRooms

根据给到的过滤器搜索，过滤给到的的房间

一般用来对搜索结果或者Trace/Region的房间进行再过滤

请求地址:

/api/db/filterrooms

请求正文:

字段 类型 说明
Source []string 原始房间
Filter RoomFilter 房间过滤器

返回结果：

字段 类型 说明
[]object? 房间
Key string 房间主键
Name string 房间名
Desc string 房间描述
Group string 房间分组
Tags []object 房间标签
--Tags.Key string 标签主键
--Tags.Value int 标签值
Exits []object 房间出口列表
--Exits.Command string 出口指令
--Exits.To string 出口房间
--Exits.Cost int 出口消耗
--Exits.Conditions []object 出口条件列表
--Exits.Conditions.Key string 条件主键
--Exits.Conditions.Not bool 条件取否
--Exits.Conditions.Value int 条件值
Data []object? 房间数据列表
--Data.Key string 数据主键
--Data.Value string 数据值

示例请求

POST http://127.0.0.1:8466/api/db/filterrooms HTTP/1.1

{
    "Source":["23","137"],
    "Filter":{
        "HasAnyGroup" :["扬州"]
    }
}

示例结果:

HTTP/1.1 200 OK
Connection: close
Content-Type: application/json; charset=utf-8
Date: Sat, 13 Dec 2025 13:05:10 GMT
Server: HellMapManager
Transfer-Encoding: chunked

[
  {
    "Key": "23",
    "Name": "钱庄",
    "Desc": "",
    "Group": "扬州",
    "Tags": [],
    "Exits": [
      {
        "Command": "e",
        "To": "22",
        "Conditions": [],
        "Cost": 1
      }
    ],
    "Data": []
  }
]