EditorPaths¶

继承： Object

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

描述¶

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

注意：此单例在导出的项目中不可访问。尝试在导出的项目中访问它将导致脚本错误，因为不会声明单例。要防止导出项目中的脚本错误，请使用Engine.has_singleton()在使用前检查单例是否可用。

注意：在Linux/BSD平台上，i3D符合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%\i3D\
- macOS: ~/Library/Caches/i3D/
- Linux: ~/.cache/i3d/

String get_config_dir() const 🔗

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

每个平台的默认路径：

- Windows: %APPDATA%\i3D\                    (same as `get_data_dir()`)
- macOS: ~/Library/Application Support/i3D/  (same as `get_data_dir()`)
- Linux: ~/.config/i3d/

String get_data_dir() const 🔗

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

每个平台的默认路径：

- Windows: %APPDATA%\i3D\                    (same as `get_config_dir()`)
- macOS: ~/Library/Application Support/i3D/  (same as `get_config_dir()`)
- Linux: ~/.local/share/i3d/

String get_project_settings_dir() const 🔗

返回特定于项目的编辑器设置路径。项目都在设置路径中有一个唯一的子目录，其中保存了特定于项目的编辑器设置。

String get_self_contained_file() const 🔗

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

bool is_self_contained() const 🔗

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

可以通过创建一个名为的文件来启用自包含模式。_sc_或_sc_在编辑器未运行时与编辑器二进制文件或macOS. app包位于同一文件夹中。另请参见get_self_contained_file()。

注意：在macOS上，隔离标志应在使用自包含模式之前手动删除，请参阅在macOS上运行。

注意：在macOS上，将_sc_或任何其他文件放在. app包中会破坏数字签名并使其不可移植，请考虑将其放在与.app包相同的文件夹中。

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