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. Вы можете переопределить переменные среды, следуя спецификации, чтобы изменить пути к данным редактора и проекта.

Обучающие материалы

Пути к файлам в проектах Godot

Методы

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\                    (same as `get_data_dir()`)
- macOS: ~/Library/Application Support/Godot/  (same as `get_data_dir()`)
- Linux: ~/.config/godot/

String get_data_dir() const 🔗

Возвращает абсолютный путь к папке данных пользователя. Эту папку следует использовать для постоянных файлов данных пользователя, таких как установленные шаблоны экспорта.

Пути по умолчанию для каждой платформы:

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

String get_project_settings_dir() const 🔗

Возвращает относительный путь к настройкам редактора для данного проекта. Обычно это "res://.godot/editor". Все проекты имеют уникальную подпапку внутри пути к настройкам, где сохраняются специфические для проекта параметры редактора.

String get_self_contained_file() const 🔗

Возвращает абсолютный путь к автономному файлу, который делает текущий экземпляр редактора Godot автономным. Возвращает пустую строку, если текущий экземпляр редактора Godot не автономен. См. также is_self_contained().

bool is_self_contained() const 🔗

Возвращает true, если редактор отмечен как автономный, false в противном случае. Когда автономный режим включен, пользовательская конфигурация, данные и файлы кэша сохраняются в папке editor_data/ рядом с двоичным файлом редактора. Это упрощает портативное использование и гарантирует, что редактор Godot минимизирует запись файлов за пределами своей собственной папки. Автономный режим недоступен для экспортированных проектов.

Автономный режим можно включить, создав файл с именем ._sc_ или _sc_ в той же папке, что и двоичный файл редактора или пакет macOS .app, пока редактор не запущен. См. также get_self_contained_file().

Примечание: На macOS флаг карантина должен быть вручную удален перед использованием автономного режима, см. Запуск на macOS.

Примечание: На macOS размещение _sc_ или любого другого файла внутри пакета .app нарушит цифровую подпись и сделает его непереносимым, рассмотрите возможность размещения его в той же папке, что и пакет .app.

Примечание: В Steam-релизе Godot по умолчанию используется автономный режим.