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...
SceneState
Наследует: RefCounted < Object
Предоставляет доступ к информации файла сцены.
Описание
Поддерживает список ресурсов, узлов, экспортированных и переопределенных свойств и встроенных скриптов, связанных со сценой. Их нельзя изменить из SceneState, к ним можно только получить доступ. Полезно для просмотра содержимого PackedScene без создания его экземпляра.
Этот класс нельзя создать напрямую, он извлекается для заданной сцены как результат PackedScene.get_state().
Методы
get_base_scene_state() const |
|
get_connection_binds(idx: int) const |
|
get_connection_count() const |
|
get_connection_flags(idx: int) const |
|
get_connection_method(idx: int) const |
|
get_connection_signal(idx: int) const |
|
get_connection_source(idx: int) const |
|
get_connection_target(idx: int) const |
|
get_connection_unbinds(idx: int) const |
|
get_node_count() const |
|
get_node_groups(idx: int) const |
|
get_node_index(idx: int) const |
|
get_node_instance(idx: int) const |
|
get_node_instance_placeholder(idx: int) const |
|
get_node_name(idx: int) const |
|
get_node_owner_path(idx: int) const |
|
get_node_path(idx: int, for_parent: bool = false) const |
|
get_node_property_count(idx: int) const |
|
get_node_property_name(idx: int, prop_idx: int) const |
|
get_node_property_value(idx: int, prop_idx: int) const |
|
get_node_type(idx: int) const |
|
get_path() const |
|
is_node_instance_placeholder(idx: int) const |
Перечисления
enum GenEditState: 🔗
GenEditState GEN_EDIT_STATE_DISABLED = 0
Если передано в PackedScene.instantiate(), блокирует редактирование состояния сцены.
GenEditState GEN_EDIT_STATE_INSTANCE = 1
Если передано в PackedScene.instantiate(), предоставляет унаследованные ресурсы сцены локальной сцене.
Примечание: Доступно только в сборках редактора.
GenEditState GEN_EDIT_STATE_MAIN = 2
Если передано в PackedScene.instantiate(), предоставляет локальные ресурсы сцены локальной сцене. Только основная сцена должна получать основное состояние редактирования.
Примечание: Доступно только в сборках редактора.
GenEditState GEN_EDIT_STATE_MAIN_INHERITED = 3
Если передано в PackedScene.instantiate(), то это похоже на GEN_EDIT_STATE_MAIN, но для случая, когда сцена создается как основа для другой.
Примечание: Доступно только в сборках редактора.
Описания метода
SceneState get_base_scene_state() const 🔗
Возвращает SceneState сцены, от которой эта сцена наследует, или null, если она не наследует ни от одной сцены.
Array get_connection_binds(idx: int) const 🔗
Возвращает список связанных параметров для сигнала в idx.
int get_connection_count() const 🔗
Возвращает количество сигнальных соединений в сцене.
Аргумент idx, используемый для запроса метаданных соединения в других методах get_connection_* в интервале [0, get_connection_count() - 1].
int get_connection_flags(idx: int) const 🔗
Возвращает флаги соединения для сигнала в idx. См. константы ConnectFlags.
StringName get_connection_method(idx: int) const 🔗
Возвращает метод, подключенный к сигналу в idx.
StringName get_connection_signal(idx: int) const 🔗
Возвращает имя сигнала в idx.
NodePath get_connection_source(idx: int) const 🔗
Возвращает путь к узлу, которому принадлежит сигнал в idx, относительно корневого узла.
NodePath get_connection_target(idx: int) const 🔗
Возвращает путь к узлу, которому принадлежит метод, подключенный к сигналу в idx, относительно корневого узла.
int get_connection_unbinds(idx: int) const 🔗
Возвращает количество несвязанных параметров для сигнала в idx.
Возвращает количество узлов в сцене.
Аргумент idx, используемый для запроса данных узлов в других методах get_node_* в интервале [0, get_node_count() - 1].
PackedStringArray get_node_groups(idx: int) const 🔗
Возвращает список имен групп, связанных с узлом в idx.
int get_node_index(idx: int) const 🔗
Возвращает индекс узла, который является его позицией относительно его братьев и сестер. Это имеет значение и сохраняется в сценах только в случаях, когда новые узлы добавляются в инстанцированную или унаследованную сцену среди братьев и сестер из базовой сцены. Несмотря на название, этот индекс не связан с аргументом idx, используемым здесь и в других методах.
PackedScene get_node_instance(idx: int) const 🔗
Возвращает PackedScene для узла в idx (т. е. всю ветвь, начинающуюся с этого узла, с ее дочерними узлами и ресурсами), или null, если узел не является экземпляром.
String get_node_instance_placeholder(idx: int) const 🔗
Возвращает путь к представленному файлу сцены, если узел в idx является InstancePlaceholder.
StringName get_node_name(idx: int) const 🔗
Возвращает имя узла в idx.
NodePath get_node_owner_path(idx: int) const 🔗
Возвращает путь к владельцу узла по адресу idx относительно корневого узла.
NodePath get_node_path(idx: int, for_parent: bool = false) const 🔗
Возвращает путь к узлу в idx.
Если for_parent равен true, вместо этого возвращается путь к родительскому узлу idx.
int get_node_property_count(idx: int) const 🔗
Возвращает количество экспортированных или переопределенных свойств для узла в idx.
Аргумент prop_idx, используемый для запроса данных свойств узла в других методах get_node_property_* в интервале [0, get_node_property_count() - 1].
StringName get_node_property_name(idx: int, prop_idx: int) const 🔗
Возвращает имя свойства в prop_idx для узла в idx.
Variant get_node_property_value(idx: int, prop_idx: int) const 🔗
Возвращает значение свойства в prop_idx для узла в idx.
StringName get_node_type(idx: int) const 🔗
Возвращает тип узла в idx.
Возвращает путь к ресурсу представленной PackedScene.
bool is_node_instance_placeholder(idx: int) const 🔗
Возвращает true, если узел в idx является InstancePlaceholder.