Skip to content

DataStoreRemoveOptions

DataStore:RemoveAsync 的可选参数,可通过 DataStoreRemoveOptions.New() 构造。

概览

DataStore:RemoveAsync 的可选参数类型,可控制删除时是否返回键元信息、是否永久删除,以及是否要求当前版本匹配指定前置版本。

可通过 DataStoreRemoveOptions.New() 构造

代码示例

构造选项

lua
-- @runtime client
local opts = DataStoreRemoveOptions.New()

属性

名称类型默认值说明
WithKeyInfoBool-设置删除操作是否返回 DataStoreKeyInfo 实例,其中包含版本号、创建和修改日期、UserIds 和 Metas 等信息。为 true 时,如果键不存在,则返回 nil。该属性为可选布尔值。
PermanentlyRemoveBool-设置是否永久删除该数据键的记录,而非默认的软删除。为 true 时执行永久删除,不可恢复;为 false 或未设置时执行软删除。该属性为可选布尔值。
DependPrevVersionString-设置依赖的前置版本号,仅当数据存储中该键的当前版本与这里指定的版本一致时,删除操作才会执行;若不一致则删除失败。该属性为可选字符串。