Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

EditorPaths

继承： Object

编辑器专用单例，返回特定于操作系统的各种数据文件夹和文件的路径。

描述

这个仅供编辑器使用的单例，可返回特定于操作系统的，到各种数据文件夹和文件的路径。它可以在编辑器插件中使用，以确保文件被保存在各个操作系统的正确位置。

注意：这个单例在导出的项目中是不可访问的。尝试在导出的项目中访问它会产生脚本错误，因为该单例没有被声明。为防止导出项目中出现脚本错误，请使用 Engine.has_singleton 检查单例是否可用后再使用该单例。

注意：在 Linux/BSD 平台上，Godot 遵守 XDG 基本目录规范。可以按照规范覆盖环境变量，来更改编辑器和项目数据路径。

教程

方法

String

get_cache_dir() const

String

get_config_dir() const

String

get_data_dir() const

String

get_project_settings_dir() const

String

get_self_contained_file() const

bool

is_self_contained() const

方法说明

String get_cache_dir() const 🔗

返回用户缓存文件夹的绝对路径。该文件夹应该用于临时数据，关闭编辑器时应该能够安全地移除这些数据（例如生成的资源预览图）。

各平台的默认路径：

- Windows: %LOCALAPPDATA%\Godot\
- macOS: ~/Library/Caches/Godot/
- Linux: ~/.cache/godot/

String get_config_dir() const 🔗

返回用户配置文件夹的绝对路径。该文件夹应该用于持久化的用户配置文件。

各平台的默认路径：

- Windows: %APPDATA%\Godot\                    （同 `get_data_dir()`）
- macOS: ~/Library/Application Support/Godot/  （同 `get_data_dir()`）
- Linux: ~/.config/godot/

String get_data_dir() const 🔗

返回用户数据文件夹的绝对路径。该文件夹应该用于持久化的用户数据文件，例如已安装的导出模板。

各平台的默认路径：

- Windows：%APPDATA%\Godot\                    （同 `get_config_dir()` ）
- macOS：~/Library/Application Support/Godot/  （同 `get_config_dir()` ）
- Linux：~/.local/share/godot/

String get_project_settings_dir() const 🔗

返回针对项目的编辑器设置路径。各个项目在设置路径中都有一个独立的子目录，用于保存针对项目的编辑器设置。

String get_self_contained_file() const 🔗

返回自包含文件的绝对路径，该文件会使当前 Godot 编辑器实例被视为是自包含的。如果当前 Godot 编辑器实例不是自包含的，则返回一个空字符串。另见 is_self_contained。

bool is_self_contained() const 🔗

如果编辑器被标记为是自包含的，则返回 true，否则返回 false。启用自包含模式后，用户配置、数据和缓存文件将保被存在编辑器二进制文件旁边的 editor_data/ 文件夹中。这使得便携使用更容易，并确保 Godot 编辑器最大限度地减少将文件写入到它自己的文件夹之外的情况。自包含模式不适用于导出的项目。

当编辑器未运行时，可以通过在与编辑器二进制文件或 macOS .app 捆绑包相同的文件夹中创建名为 ._sc_ 或 _sc_ 的文件来启用自包含模式。另见 get_self_contained_file。

注意：在 macOS 上，应当在使用自包含模式前手动移除隔离标志，见《在 macOS 上运行》。

注意：在 macOS 上，将 _sc_ 或任何其他文件放入 .app 捆绑包中会破坏其数字签名，使其不再便携，请考虑改为放在与 .app 捆绑包相同的文件夹中。

注意：Godot 的 Steam 版本默认使用自包含模式。