ToolDelta Wiki

主题

类式插件的数据文件 ​

ToolDelta 类式插件为生成数据文件路径提供了一些实用方法。

以下的方法均为 Plugin 类中的函数。

生成此插件的数据文件文件夹 ​

python
def make_data_path()

已弃用

make_data_path() 已弃用：直接访问 self.data_path 属性就会自动创建数据文件夹，无需手动调用。

  • 根据该插件主类的 name: str 生成数据文件的文件夹。
  • 例如：name = "test"，则会创建 插件数据文件/test/ 文件夹。
  • 示例：
python
class MyPlugin(Plugin):
    name = "我的插件"

    def __init__(self):
        # 创建 `插件数据文件/我的插件/` 文件夹
        self.make_data_path()

获取该插件的数据文件文件夹路径 ​

python
data_path: pathlib.Path
  • 该属性返回 pathlib.Path 对象，等价于 插件数据文件/<插件名>（即 TOOLDELTA_PLUGIN_DATA_DIR / self.name）。
  • 在获取 data_path 时，会自动创建数据文件夹。
  • 推荐直接使用 / 运算符拼接子路径，例如 self.data_path / "商店.json"。
  • 示例：
python
class MyPlugin(Plugin):
    name = "我的插件"

    def __init__(self):
        print(self.data_path)
        # 插件数据文件\我的插件

获取格式化的数据文件路径 ​

python
def format_data_path(*path: str) -> str

已弃用

format_data_path() 已弃用，请改用 self.data_path / "子目录" / "文件名"。

  • 等价于 os.path.join(self.data_path, *path)
  • 示例：
python
class MyPlugin(Plugin):
    name = "我的插件"

    def __init__(self):
        # 会生成 "插件数据文件/我的插件/商店.json"
        path1 = self.format_data_path("商店.json")
        # 会生成 "插件数据文件/我的插件/玩家数据/Steve.json"
        path2 = self.format_data_path("玩家数据", "Steve.json")

获取插件配置与版本 ​

python
def get_config_and_version(
    template: dict,
    default_cfg: dict
) -> tuple[dict, tuple[int, int, int]]
  • Plugin 提供的便捷方法，等价于 cfg.get_plugin_config_and_version(self.name, template, default_cfg, self.version)。
  • 返回值为 (配置内容, 配置版本) 二元组。
  • 详细用法见 配置文件。