Skip to content

OrderedDataStore

有序数据存储集合,仅由 DataStoreService:GetOrderedDataStore() 返回。

概览

有序数据存储集合,专门用于保存整数键值对,并按数值大小排序后查询。只能通过 DataStoreService:GetOrderedDataStore 获得实例,无法自行构造;其核心能力是使用 GetSortedAsync 依升序或降序读取排行数据,并配合分页对象逐页获取结果。

继承自 DataStore;不可实例化,由接口返回

函数

GetSortedAsync

签名:GetSortedAsync(ascending: Bool, pageSize: Int?, minValue: Int?, maxValue: Int?, options: DataStoreGetOptions?) -> OrderedDataStoreKeyValueInfoPages

从有序数据存储中获取所有键值对数据,返回结果会按照存储的值(value)进行升序或降序排列。数据以分页形式返回,可通过返回的分页对象逐页读取每一页的键值信息。

注意: 当前 Editor 运行包尚未提供 data_store_get_sorted_key_value_pairs 底层绑定,调用 GetSortedAsync 会失败。公开签名按 Meta 保留;在运行包补齐绑定并完成目标版本验证前,不应把该方法用于可运行示例。

参数类型说明
ascendingBool是否升序
pageSizeInt页大小, 默认 0 (使用服务端默认值)
minValueInt最小值过滤, 包含
maxValueInt最大值过滤, 包含
optionsDataStoreGetOptions可选参数, 优先级高于 OrderedDataStore 创建时的 DataStoreOptions, 可通过 DataStoreGetOptions.New() 创建

返回值 OrderedDataStoreKeyValueInfoPages — 分页的键值对结果,按值排序,通过迭代器逐页获取