Entity

public Entity.AutoTranslateModeEnum AutoTranslateMode { get; set; }

Определяет, следует ли автоматически изменять любой текст на его переведенную версию в зависимости от текущей локали (для таких сущностей, как Label, RichTextLabel, Window и т. д.). Также определяет, следует ли анализировать строки сущности для генерации шаблона перевода. Примечание: Для корневого сущности режим автоматического перевода также можно установить через ProjectSettings.internationalization/rendering/root_node_auto_translate.

public string EditorDescription { get; set; }

Необязательное описание сущности. Оно будет отображаться как подсказка при наведении курсора на сущность в доке сцены редактора.

public MultiplayerApi Multiplayer { get; }

Экземпляр MultiplayerApi, связанный с этим сущностью. См. EntityTree.GetMultiplayer. Примечание: Переименование сущности или перемещение его в дереве не переместит MultiplayerApi на новый путь, вам придется обновить его вручную.

public StringName Name { get; set; }

Имя сущности. Это имя должно быть уникальным среди сестринских сущностей (других дочерних сущностей того же родителя). При установке на имя существующего сестринского сущности сущность автоматически переименовывается. Примечание: При изменении имени следующие символы будут заменены подчеркиванием: (. : @ / " %). В частности, символ @ зарезервирован для автоматически сгенерированных имен. См. также String.validate_node_name.

Владелец

public Entity Owner { get; set; }

Владелец сохраняемой иерархии, не родитель и не счётчик ссылок. Ненулевой владелец должен быть предком; назначайте после AddChild. Сам AddChild не назначает Owner, поэтому программно добавленный ребёнок может не попасть в PackedEntity.Pack.

public Entity.PhysicsInterpolationModeEnum PhysicsInterpolationMode { get; set; }

Локальный режим Inherit/On/Off. Работает совместно с глобально включённой физической интерполяцией. Off не отменяет пространственное влияние интерполируемого родителя.

public Entity.ProcessModeEnum ProcessMode { get; set; }

Управляет обычной обработкой при паузе/отключении. Inherit следует Parent, не Owner. Не блокирует прямые вызовы методов и сигналы.

public int ProcessPhysicsPriority { get; set; }

Аналогично Entity.ProcessPriority, но для Entity.NotificationPhysicsProcess, Entity._PhysicsProcess или Entity.NotificationInternalPhysicsProcess.

public int ProcessPriority { get; set; }

Порядок выполнения обратных вызовов процесса сущности (Entity._Process, Entity.NotificationProcess и Entity.NotificationInternalProcess). сущности, приоритет которых ниже, вызывают обратные вызовы своего процесса в первую очередь, независимо от порядка дерева.

public Entity.ProcessThreadGroupEnum ProcessThreadGroup { get; set; }

Установите группу потоков процесса для этого сущности (в основном, получает ли он Entity.NotificationProcess, Entity.NotificationPhysicsProcess, Entity._Process или Entity._PhysicsProcess (и внутренние версии) в основном потоке или в подпотоке. По умолчанию группа потоков — Entity.ProcessThreadGroupEnum.Inherit, что означает, что этот сущность принадлежит к той же группе потоков, что и родительский сущность. Группы потоков означают, что сущности в определенной группе потоков будут обрабатываться вместе, отдельно от других групп потоков (в зависимости от Entity.ProcessThreadGroupOrder). Если установлено значение Entity.ProcessThreadGroupEnum.SubThread, эта группа потоков будет выполняться в подпотоке (не в основном потоке), в противном случае, если установлено значение Entity.ProcessThreadGroupEnum.MainThread, она будет обрабатываться в основном потоке. Если есть не родительский или прародительский сущность, для которого установлено значение, отличное от inheritage, сущность будет принадлежать группе потоков по умолчанию. Эта группа по умолчанию будет обрабатываться в главном потоке, а ее порядок группы равен 0. Во время обработки в подпотоке доступ к большинству функций в узлах за пределами группы потоков запрещен (и это приведет к ошибке в режиме отладки). Используйте ReckfellObject.CallDeferred, Entity.CallThreadSafe, Entity.CallDeferredThreadGroup и тому подобное для связи из групп потоков с основным потоком (или с другими группами потоков). Чтобы лучше понять группы потоков процесса, идея заключается в том, что любой сущность, установленный на любое другое значение, чем Entity.ProcessThreadGroupEnum.Inherit, включит любые дочерние (и внучатые) сущности, установленные для наследования в его группу потоков процесса. Это означает, что обработка всех сущностей в группе будет происходить вместе, в то же время, когда сущность включает их.

public int ProcessThreadGroupOrder { get; set; }

Измените порядок групп потоков процесса. Группы с меньшим порядком будут обрабатываться до групп с большим порядком. Это полезно, когда большое количество сущностей обрабатывается в подпотоке, а затем другая группа хочет собрать свой результат в главном потоке, например.

public Entity.ProcessThreadMessagesEnum ProcessThreadMessages { get; set; }

Установите, будет ли текущая группа потоков обрабатывать сообщения (вызовы Entity.CallDeferredThreadGroup в потоках), и хочет ли она получать их во время обычных процессов или обратных вызовов физических процессов.

public string SourceAssetPath { get; set; }

Логический исходный путь корня загруженного PackedEntity. Не является путём каждого потомка и не определяет отдельный класс Entity. У дерева из new Entity может быть пустым.

public bool UniqueNameInOwner { get; set; }

Регистрирует имя для поиска %Name в области Owner. Это не глобальная уникальность, UID файла или сетевой ID.

public void AddChild(Entity node, bool forceReadableName = false, Entity.InternalMode @internal = Entity.InternalMode.Disabled);

Подключает Entity как дочернюю. У неё не должно быть другого родителя. Если этот родитель уже в активном дереве, вход и подготовка ребёнка могут выполниться до возвращения из вызова: начальные свойства задавайте заранее. Не назначает Owner автоматически.

public void AddSibling(Entity sibling, bool forceReadableName = false);

Добавить a sibling Угол к родителю этого сущности, и двигает дополнительного брата прямо под этим сущностью. Если force_readable_name это true, улучшает удобочитаемость добавленного sibling. Если не указано, то: sibling переименован в свой тип, и если он делится Entity.Name При помощи сестринского брата более уместно установить число suffling. Эта операция осуществляется очень медленно. false, который присваивает название манекена с указанием @ в обеих ситуациях. Использование Entity.AddChild вместо этого метода, если вы не хотите добавить детский сущность под конкретным сущностью в списке детей. Примечание: Если этот сущность является внутренним, то дополнительный брат тоже будет внутренним (см. Entity.AddChild's internal параметр).

public void AddToGroup(StringName group, bool persistent = false);

Добавляет метку группы. До входа IsInGroup уже true, но дерево ещё не находит участника. persistent нужен для записи в PackedEntity; повторное добавление не меняет этот флаг.

public string Atr(string message, StringName context = null);

Переводит message, используя каталоги перевода, настроенные в настройках проекта. Для помощи с переводом можно указать дополнительный context. Обратите внимание, что большинство сущностей Control автоматически переводят свои строки, поэтому этот метод в основном полезен для форматированных строк или пользовательского нарисованного текста. Этот метод работает так же, как ReckfellObject.Tr, с добавлением соблюдения состояния Entity.AutoTranslateMode. Если ReckfellObject.CanTranslateMessages равен false или перевод недоступен, этот метод возвращает message без изменений. См. ReckfellObject.SetMessageTranslation. Подробные примеры см. в Интернационализация игр.

public string AtrN(string message, StringName pluralMessage, int n, StringName context = null);

Переводит message или plural_message, используя каталоги перевода, настроенные в настройках проекта. Для помощи с переводом можно указать дополнительный context. Этот метод работает так же, как ReckfellObject.TrN, с добавлением соблюдения состояния Entity.AutoTranslateMode. Если ReckfellObject.CanTranslateMessages имеет значение false или перевод недоступен, этот метод возвращает message или plural_message без изменений. См. ReckfellObject.SetMessageTranslation. n — это номер или количество темы сообщения. Он используется системой перевода для получения правильной формы множественного числа для текущего языка. Подробные примеры см. в Локализация с использованием gettext. Примечание: Отрицательные и Entity.Atr.

public Variant CallDeferredThreadGroup(StringName method, params Variant[] args);

Эта функция похожа на ReckfellObject.CallDeferred, за исключением того, что вызов будет иметь место, когда обрабатывается группа потоков сущности. Если группа потоков сущности обрабатывается в подпотоках, то вызов будет сделан в этом потоке, прямо перед вызовом Entity.NotificationProcess или Entity.NotificationPhysicsProcess, Entity._Process или Entity._PhysicsProcess или их внутренних версий.

public Variant CallDeferredThreadGroup(StringName method, ReadOnlySpan<Variant> args);

Эта функция похожа на ReckfellObject.CallDeferred, за исключением того, что вызов будет иметь место, когда обрабатывается группа потоков сущности. Если группа потоков сущности обрабатывается в подпотоках, то вызов будет сделан в этом потоке, прямо перед вызовом Entity.NotificationProcess или Entity.NotificationPhysicsProcess, Entity._Process или Entity._PhysicsProcess или их внутренних версий.

public Variant CallThreadSafe(StringName method, params Variant[] args);

Эта функция гарантирует, что вызов этой функции будет успешным, независимо от того, выполняется ли он из потока или нет. Если он вызван из потока, которому не разрешено вызывать функцию, вызов станет отложенным. В противном случае вызов будет выполнен напрямую.

public Variant CallThreadSafe(StringName method, ReadOnlySpan<Variant> args);

Эта функция гарантирует, что вызов этой функции будет успешным, независимо от того, выполняется ли он из потока или нет. Если он вызван из потока, которому не разрешено вызывать функцию, вызов станет отложенным. В противном случае вызов будет выполнен напрямую.

public bool CanAutoTranslate();

Возвращает true, если этот сущность может автоматически переводить сообщения в зависимости от текущей локали. См. Entity.AutoTranslateMode, Entity.Atr и Entity.AtrN.

public bool CanProcess();

Проверяет активное дерево и допустимость обработки по текущему состоянию/ProcessMode. Отличается от флага IsProcessing.

public Tween CreateTween();

Создаёт Tween через доступное EntityTree и связывает его с этой Entity. Если она временно вне дерева, связанная анимация приостанавливается; при удалении Entity Tween прекращается. Один только выход из дерева не означает автоматический возврат анимируемых свойств к исходным значениям. Для повторного независимого запуска создавайте новый Tween, не переиспользуйте завершённый или остановленный через Kill().

public Entity Duplicate(int flags = 15);

Подделывает сущность, возвращая новый сущность со всеми его свойствами, сигналами, группами и детьми, скопированными с оригинала, рекурсивно. flags (см. Entity.DuplicateFlags) Внутренние сущности не дублируются. Примечание: Для сущностей с a Script прилагаемый, если Object._init , был определен с требуемыми параметрами, дубликат сущности не будет иметь Script. Примечание: По умолчанию этот метод дублирует только свойства, помеченные для серийной обработки (т.е. PropertyUsageFlags.Storageили в C#, Entity.DuplicateFlags.InternalState.

public Entity FindChild(string pattern, bool recursive = true, bool owned = true);

Находит первого потомка этого сущности, чье Entity.Name соответствует pattern, возвращая null, если совпадений не найдено. Сопоставление выполняется с именами сущностей, не их путями, через String.match. Таким образом, он чувствителен к регистру, "*" соответствует нулю или более символов, а "?" соответствует любому одному символу. Если recursive равен false, проверяются только прямые потомки этого сущности. сущности проверяются в порядке дерева, поэтому сначала проверяется первый прямой потомок этого сущности, затем его собственные прямые потомки и т. д., прежде чем перейти ко второму прямому потомку и т. д. Внутренние потомки также включаются в поиск (см. параметр internal в Entity.AddChild). Если owned равен true, проверяются только потомки с допустимым сущностью Entity.Owner. Примечание: Этот метод может быть очень медленным. Рассмотрите возможность сохранения ссылки на найденный сущность в переменной. В качестве альтернативы используйте Entity.GetEntity с уникальными именами (см. Entity.UniqueNameInOwner). Примечание: Чтобы найти все сущности-потомки, соответствующие шаблону или типу класса, см. Entity.FindChildren.

public Reckfell.Collections.Array<Entity> FindChildren(string pattern, string type = "", bool recursive = true, bool owned = true);

Находит всех потомков этого сущности, чьи имена соответствуют pattern, возвращая пустой Reckfell.Collections.Array, если совпадение не найдено. Сопоставление выполняется по именам сущностей, а не их путям, с помощью String.match. Таким образом, оно чувствительно к регистру: "*" соответствует нулю или более символам, а "?" соответствует любому отдельному символу. Если type не пуст, включаются только потомки, наследующие от type (см. ReckfellObject.IsClass). Если recursive равно false, проверяются только непосредственные потомки этого сущности. сущности проверяются в порядке дерева, поэтому сначала проверяется первый непосредственный потомок этого сущности, затем его собственные непосредственные потомки и т. д., прежде чем перейти ко второму непосредственному потомку и так далее. В поиск также включаются внутренние потомки (см. internal параметр в Entity.AddChild). Если owned равно true, проверяются только потомки с действительным сущностью Entity.Owner. Примечание: Этот метод может быть очень медленным. Рекомендуется сохранять ссылки на найденные сущности в переменной. Примечание: Чтобы найти единственный дочерний сущность, соответствующий шаблону, см. Entity.FindChild.

public Entity FindParent(string pattern);

Находит первого предка этого сущности, чье Entity.Name соответствует pattern, возвращая null, если совпадений не найдено. Сопоставление выполняется с помощью String.match. Таким образом, он чувствителен к регистру, "*" соответствует нулю или более символов, а "?" соответствует любому отдельному символу. См. также Entity.FindChild и Entity.FindChildren. Примечание: Поскольку этот метод идет вверх по дереву сцены, он может быть медленным в больших, глубоко вложенных узлах. Рассмотрите возможность сохранения ссылки на найденный сущность в переменной. В качестве альтернативы используйте Entity.GetEntity с уникальными именами (см. Entity.UniqueNameInOwner).

public Rid GetAccessibilityElement();

Возвращает основной элемент доступности RID. Примечание: Этот метод следует вызывать только во время обновлений информации о доступности (Entity.NotificationAccessibilityUpdate).

public Entity GetChild(int idx, bool includeInternal = false);

Извлекает дочерний сущность по его индексу. Каждый дочерний сущность имеет индекс относительно своих братьев и сестер (см. Entity.GetIndex). Первый дочерний сущность имеет индекс 0. Отрицательные значения также могут использоваться для начала с конца списка. Этот метод можно использовать в сочетании с Entity.GetChildCount для итерации по дочерним узлам этого сущности. Если по указанному индексу дочерний сущность не существует, этот метод возвращает null и генерируется ошибка. Если include_internal равен false, внутренние дочерние сущности игнорируются (см. параметр Entity.AddChild internal).

Примечание: Чтобы получить сущность по EntityPath, используйте Entity.GetEntity.

public T GetChild<T>(int idx, bool includeInternal = false) where T : class;

Извлекает дочерний сущность по его индексу. Каждый дочерний сущность имеет индекс относительно своих братьев и сестер (см. Entity.GetIndex). Первый дочерний сущность имеет индекс 0. Отрицательные значения также могут использоваться для начала с конца списка. Этот метод можно использовать в сочетании с Entity.GetChildCount для итерации по дочерним узлам этого сущности. Если по указанному индексу дочерний сущность не существует, этот метод возвращает null и генерируется ошибка. Если include_internal равен false, внутренние дочерние сущности игнорируются (см. параметр Entity.AddChild internal).

Примечание: Чтобы получить сущность по EntityPath, используйте Entity.GetEntity.

public int GetChildCount(bool includeInternal = false);

Возвращает количество детей этого сущности. Если include_internal это false, внутренние дети не учитываются (см. Entity.AddChild's internal параметр).

public T GetChildOrNull<T>(int idx, bool includeInternal = false) where T : class;

Возвращает детский сущность по индексу (см. Entity.GetChildCount). Этот метод часто используется для итерации всех детей сущности. Негативные показатели позволяют детям получить доступ к последним. Доступ к детскому сущности через его имя, использование Entity.GetEntity.

public Reckfell.Collections.Array<Entity> GetChildren(bool includeInternal = false);

Возвращает всех детей этого сущности в Reckfell.Collections.Array. Если include_internal это false, исключить внутренних детей из возвращенного массива (см. Entity.AddChild's internal параметр).

public Entity GetEntity(EntityPath path);

Возвращает сущность по пути относительно текущей сущности. Абсолютный путь начинается с /root и требует, чтобы текущая сущность находилась в дереве. Если путь не существует, движок сообщает об ошибке и возвращает null. Для необязательной ссылки используйте GetEntityOrNull().

public T GetEntity<T>(EntityPath path) where T : class;

Ищет сущность по пути и приводит результат к T. Отсутствующий путь сообщает об ошибке; несовместимый тип вызывает InvalidCastException. Используйте эту перегрузку, когда структура префаба известна. Для необязательной сущности или проверки типа используйте GetEntityOrNull<T>().

public Reckfell.Collections.Array GetEntityAndResource(EntityPath path);

Привозит сущность и его самый гнездистый ресурс, указанный EntityPathВернётся. Reckfell.Collections.Array размер 3 где:

• Элемент 0 это Entityили null если они не найдены;
• Элемент 1 это последнее гнездо под имени Resourceили null если они не найдены;
• Элемент 2 - остальные EntityPath, с указанием существующего,Resource имущество (см. ReckfellObject.GetIndexed). Пример: Предположим, что ребенок Sprite2D.Texture назначено AtlasTexture:

var a = GetEntityAndResource(EntityPath("Area2D/Sprite2D"));
ReckfellApi.Print(a[0].Name); // Prints Sprite2D
ReckfellApi.Print(a[1]);      // Prints <null>
ReckfellApi.Print(a[2]);      // Prints ^"

var b = GetEntityAndResource(EntityPath("Area2D/Sprite2D:texture:atlas"));
ReckfellApi.Print(b[0].name);        // Prints Sprite2D
ReckfellApi.Print(b[1].get_class()); // Prints AtlasTexture
ReckfellApi.Print(b[2]);             // Prints ^""

var c = GetEntityAndResource(EntityPath("Area2D/Sprite2D:texture:atlas:region"));
ReckfellApi.Print(c[0].name);        // Prints Sprite2D
ReckfellApi.Print(c[1].get_class()); // Prints AtlasTexture
ReckfellApi.Print(c[2]);             // Prints ^":region"

public Entity GetEntityOrNull(EntityPath path);

Возвращает объект по пути либо null. В generic-варианте несовместимый тип также даёт null. Проверяйте область %Name и ожидаемый класс.

public T GetEntityOrNull<T>(EntityPath path) where T : class;

Возвращает объект по пути либо null. В generic-варианте несовместимый тип также даёт null. Проверяйте область %Name и ожидаемый класс.

public Variant GetEntityRpcConfig();

Возвращает Reckfell.Collections.Dictionary, сопоставляющий имена методов с их конфигурацией RPC, определенной для этого сущности, с помощью Entity.RpcConfig. Примечание: Этот метод возвращает только конфигурацию RPC, назначенную с помощью Entity.RpcConfig. См. Script.GetRpcConfig, чтобы получить RPC, определенным в Script.

public Reckfell.Collections.Array<StringName> GetGroups();

Возвращает Reckfell.Collections.Array имен групп, в которые был добавлен сущность. Примечание: Для повышения производительности порядок имен групп не гарантирован и может меняться между запусками проекта. Поэтому не полагайтесь на порядок групп. Примечание: Этот метод также может возвращать некоторые имена групп, начинающиеся с подчеркивания (_). Они используются движком внутри. Чтобы избежать конфликтов, не используйте пользовательские группы, начинающиеся с подчеркивания. Чтобы исключить внутренние группы, см. следующий фрагмент кода:

// Stores the node's non-internal groups only (as a List of StringNames).
List<string> nonInternalGroups = new List<string>();
foreach (string group in GetGroups())
{
    if (!group.BeginsWith("_"))
        nonInternalGroups.Add(group);
}

public int GetIndex(bool includeInternal = false);

Возвращает порядок этого сущности среди его братьев и сестер. Индекс первого сущности — 0. См. также Entity.GetChild. Если include_internal — false, возвращает индекс, игнорируя внутренние дочерние элементы. Первый, не внутренний дочерний элемент будет иметь индекс 0 (см. параметр Entity.AddChild internal).

public Window GetLastExclusiveWindow();

Возвращает Window, содержащее этот сущность, или последний исключительный дочерний элемент в цепочке окон, начиная с того, которое содержит этот сущность.

public int GetMultiplayerAuthority();

Возвращает идентификатор пира многопользовательского органа для этого сущности. См. Entity.SetMultiplayerAuthority.

public static Reckfell.Collections.Array<int> GetOrphanEntityIds();

Возвращает ID идентификаторы объектов всех сущностей-сирот (сущностей вне EntityTree). Используется для отладки. Примечание: Entity.GetOrphanEntityIds работает только в отладочных сборках. При вызове в проекте, экспортированном в режиме выпуска, Entity.GetOrphanEntityIds вернет пустой массив.

public T GetOwner<T>() where T : class;

Владелец сущности. У сущности может быть любой другой сущность в качестве владельца (как long Так и есть.

• действительным родителем, дедушкой и т.д., поднявшимся на дерево. сущность (используемый PackedEntity), все его сущности будут сохранены Это позволяет создавать комплексы EntityTrees, с неустойчивостью и приземлением.

public T GetOwnerOrNull<T>() where T : class;

Владелец сущности. У сущности может быть любой другой сущность в качестве владельца (как long Так и есть.

• действительным родителем, дедушкой и т.д., поднявшимся на дерево. сущность (используемый PackedEntity), все его сущности будут сохранены Это позволяет создавать комплексы EntityTrees, с неустойчивостью и приземлением.

public Entity GetParent();

Читает непосредственного родителя иерархии. Родитель не равен Owner: родительство управляет деревом и временем жизни, Owner участвует в сохранении.

public T GetParent<T>() where T : class;

Возвращает родительский сущность данного сущности или null, если у сущности нет родителя.

public T GetParentOrNull<T>() where T : class;

Возвращает родительский сущность текущего сущности или null примеры если у сущности нет родителя.

public EntityPath GetPath();

Возвращает абсолютный путь сущности относительно EntityTree.Root. Если сущность не находится внутри дерева сцены, этот метод завершается ошибкой и возвращает пустой EntityPath.

public EntityPath GetPathTo(Entity node, bool useUniquePath = false);

Возвращает относительный EntityPath от этого сущности до указанного node. Оба сущности должны находиться в одной и той же EntityTree или иерархии сцены, в противном случае этот метод завершается ошибкой и возвращает пустой EntityPath. Если use_unique_path равен true, возвращает кратчайший путь с учетом уникального имени этого сущности (см. Entity.UniqueNameInOwner). Примечание: Если вы получаете относительный путь, который начинается с уникального сущности, путь может быть длиннее обычного относительного пути из-за добавления имени уникального сущности.

public double GetPhysicsProcessDeltaTime();

Длительность физического шага в игровом времени. Для движения учитывайте семантику метода: MoveAndSlide интегрирует Velocity сам, MoveAndCollide получает перемещение.

public double GetProcessDeltaTime();

Последняя длительность обычного шага обработки в секундах игрового времени. Это не отдельные реальные часы; в _Process обычно используйте переданный delta.

public bool GetSceneInstanceLoadPlaceholder();

Возвращает true, если этот сущность является заполнителем загрузки экземпляра. См. InstancePlaceholder и Entity.SetSceneInstanceLoadPlaceholder.

public EntityTree GetTree();

Получает активное дерево этой Entity. Для объекта вне дерева сначала проверяйте IsInsideTree; метод не подключает объект автоматически.

public string GetTreeString();

Возвращает дерево как string. Используется в основном для отладки. Эта версия отображает путь относительно текущего сущности и подходит для копирования/вставки в функцию Entity.GetEntity. Также может использоваться в игровом UI/UX. Может выводить, например:

TheGame
TheGame/Menu
TheGame/Menu/Label
TheGame/Menu/Camera2D
TheGame/SplashScreen
TheGame/SplashScreen/Camera2D

public string GetTreeStringPretty();

Подобно Entity.GetTreeString, это возвращает дерево как string. Эта версия отображает более графическое представление, похожее на то, что отображается в Сцена. Это полезно для проверки больших деревьев. Может печатать, например:

┖╴TheGame
   ┠╴Menu
   ┃  ┠╴Label
   ┃  ┖╴Camera2D
   ┖╴SplashScreen
      ┖╴Camera2D

public Viewport GetViewport();

Возвращает ближайшего предка Viewport сущности, если сущность находится внутри дерева. В противном случае возвращает null.

public Window GetWindow();

Возвращает Window, содержащее этот сущность. Если сущность находится в главном окне, это эквивалентно получению корневого сущности (get_tree().get_root()).

public bool HasEntity(EntityPath path);

Возвращает true, если path указывает на допустимый сущность. См. также Entity.GetEntity.

public bool HasEntityAndResource(EntityPath path);

Возвращает true, если path указывает на допустимый сущность, а его подимена указывают на допустимый Resource, например, Area2D/CollisionShape2D:shape. Свойства, которые не являются типами Resource (например, сущности или другие типы Variant), не рассматриваются. См. также Entity.GetEntityAndResource.

public bool IsAncestorOf(Entity node);

Возвращает true, если заданный node является прямым или косвенным дочерним элементом этого сущности.

public bool IsDisplayedFolded();

Возвращает true, если сущность свёрнут в доке сцены. Этот метод предназначен для использования в плагинах и инструментах редактора. См. также Entity.SetDisplayFolded.

public bool IsEditableInstance(Entity node);

Возвращает true, если node имеет редактируемые дочерние элементы, включенные относительно этого сущности. Этот метод предназначен для использования в плагинах и инструментах редактора. См. также Entity.SetEditableInstance.

public bool IsEntityReady();

Возвращает true, если сущность готов, т. е. он находится внутри дерева сцены и все его дочерние элементы инициализированы. Entity.RequestReady сбрасывает его обратно в false.

public bool IsGreaterThan(Entity node);

Возвращает true, если заданный node встречается позже в иерархии сцены, чем этот сущность. сущность, встречающийся позже, обычно обрабатывается последним.

public bool IsInGroup(StringName group);

Проверяет сохранённую на объекте метку, даже если Entity сейчас отсоединена. Это не проверка наличия в активной выборке дерева.

public bool IsInsideTree();

Проверяет участие в активном EntityTree. Созданный или отсоединённый объект может существовать в памяти, оставаясь вне дерева. Это не проверка наличия родителя или очереди удаления.

public bool IsMultiplayerAuthority();

Возвращает true, если локальная система является многопользовательским центром этого сущности.

public bool IsPartOfEditedScene();

Возвращает true, если сущность является частью сцены, открытой в данный момент в редакторе.

public bool IsPhysicsInterpolated();

Возвращает true, если физическая интерполяция включена для этого сущности (см. Entity.PhysicsInterpolationMode). Примечание: Интерполяция будет активна только если и флаг установлен и физическая интерполяция включена в EntityTree. Это можно проверить с помощью Entity.IsPhysicsInterpolatedAndEnabled.

public bool IsPhysicsInterpolatedAndEnabled();

Возвращает true, если включена интерполяция физики (см. Entity.PhysicsInterpolationMode) и включена в EntityTree. Это удобная версия Entity.IsPhysicsInterpolated, которая также проверяет, включена ли интерполяция физики глобально. См. EntityTree.PhysicsInterpolation и ProjectSettings.physics/common/physics_interpolation.

public bool IsPhysicsProcessing();

Показывает флаг включения физического callback. Это не подтверждение фактического вызова при текущей паузе/ProcessMode и не состояние симуляции всех физических тел.

public bool IsPhysicsProcessingInternal();

Возвращает true, если включена внутренняя обработка физики (см. Entity.SetPhysicsProcessInternal).

public bool IsProcessing();

Сообщает, включён ли _Process. True не гарантирует вызов во время паузы или при запрещающем унаследованном режиме.

public bool IsProcessingInput();

Возвращает true, если сущность обрабатывает входные данные (см. Entity.SetProcessInput).

public bool IsProcessingInternal();

Возвращает true, если включена внутренняя обработка (см. Entity.SetProcessInternal).

public bool IsProcessingShortcutInput();

Возвращает true, если сущность обрабатывает сочетания клавиш (см. Entity.SetProcessShortcutInput).

public bool IsProcessingUnhandledInput();

Возвращает true, если сущность обрабатывает необработанный ввод (см. Entity.SetProcessUnhandledInput).

public bool IsProcessingUnhandledKeyInput();

Возвращает true, если сущность обрабатывает необработанный ввод с клавиатуры (см. Entity.SetProcessUnhandledKeyInput).

public void MoveChild(Entity childNode, int toIndex);

Перемещает child_node в указанный индекс. Индекс сущности — это порядок среди его братьев и сестер. Если to_index отрицательный, индекс отсчитывается с конца списка. См. также Entity.GetChild и Entity.GetIndex. Примечание: Порядок обработки нескольких обратных вызовов движка (Entity.Ready, Entity._Process и т. д.) и уведомлений, отправленных через Entity.PropagateNotification, зависит от порядка дерева. сущности CanvasItem также отображаются в порядке дерева. См. также Entity.ProcessPriority.

public void NotifyDeferredThreadGroup(int what);

Аналогично Entity.CallDeferredThreadGroup, но для уведомлений.

public void NotifyThreadSafe(int what);

Аналогично Entity.CallThreadSafe, но для уведомлений.

public static void PrintOrphanEntities();

Выводит все осиротевшие сущности (сущности вне EntityTree). Полезно для отладки. Примечание: Этот метод работает только в отладочных сборках. Он ничего не делает в проекте, экспортированном в режиме выпуска.

public void PrintTree();

Выводит сущность и его дочерние элементы на консоль рекурсивно. сущность не обязательно должен находиться внутри дерева. Этот метод выводит EntityPath относительно этого сущности и подходит для копирования/вставки в Entity.GetEntity. См. также Entity.PrintTreePretty. Может выводить, например:

.
Menu
Menu/Label
Menu/Camera2D
SplashScreen
SplashScreen/Camera2D

public void PrintTreePretty();

Выводит сущность и его дочерние элементы на консоль, рекурсивно. сущность не обязательно должен находиться внутри дерева. Аналогично Entity.PrintTree, но графическое представление выглядит так, как отображается в редакторе Сценический док. Это полезно для проверки больших деревьев. Например, может вывести:

┖╴TheGame
   ┠╴Menu
   ┃  ┠╴Label
   ┃  ┖╴Camera2D
   ┖╴SplashScreen
      ┖╴Camera2D

public void PropagateCall(StringName method, Reckfell.Collections.Array args = null, bool parentFirst = false);

Вызывает заданное имя method, передавая args в качестве аргументов, на этом сущности и всех его дочерних узлах, рекурсивно. Если parent_first равен true, метод сначала вызывается на этом сущности, затем на всех его дочерних узлах. Если false, сначала вызываются методы дочерних сущностей.

public void PropagateNotification(int what);

Синхронно отправляет указанное уведомление этой Entity, затем её потомкам. Само уведомление закрытия не завершает процесс; это может сделать обработчик через Quit(). Не рассылайте то же уведомление повторно из его обработчика.

public void QueueAccessibilityUpdate();

Ставит в очередь обновление информации о доступности для этого сущности.

public void QueueFree();

Ставит нативную Entity на отложенное удаление. Дочерние объекты, остающиеся у неё к моменту удаления, также освобождаются. В выполненной проверке сразу после вызова объект ещё был действителен, а после обработки очереди исчез вместе с ребёнком. Не путайте с RemoveChild.

public void RemoveChild(Entity node);

Отсоединяет непосредственного ребёнка без освобождения памяти. Выход из активного дерева вызывает события выхода; повторное подключение того же экземпляра не повторяет _Ready автоматически. Сохраните ссылку для повторного использования или освободите объект.

public void RemoveFromGroup(StringName group);

Удаляет метку членства и активную регистрацию, если объект находится в дереве. Не удаляет саму Entity.

public void Reparent(Entity newParent, bool keepGlobalTransform = true);

Перемещает под нового родителя. Owner сохраняется, только если остаётся допустимым предком; иначе область сохранения и уникального имени может измениться.

public void ReplaceBy(Entity node, bool keepGroups = false);

Заменяет этот сущность заданным node. Все дочерние элементы этого сущности перемещаются в node. Если keep_groups равно true, node добавляется в те же группы, в которых находится замененный сущность (см. Entity.AddToGroup). Предупреждение: Замененный сущность удаляется из дерева, но он не удаляется сам. Чтобы предотвратить утечки памяти, сохраните ссылку на сущность в переменной или используйте ReckfellObject.Free.

public void RequestReady();

Запрашивает _Ready для следующего входа только этой Entity. Не вызывает его немедленно и не обходит потомков рекурсивно.

public void ResetPhysicsInterpolation();

Сбрасывает историю интерполяции ветви после установки финального transform, например при телепорте. Вызывайте после изменения и внутри активного дерева. Не обнуляет скорости, контакты или сетевые буферы.

public Error Rpc(StringName method, params Variant[] args);

Посылает запрос на дистанционную процедуру method Запрос о вызове будет получен только узлами с теми же возможностями. EntityPath, включая то же самое Entity.NameПоведение зависит от конфигурации ОКП для данного method (см. Entity.RpcConfig и [annotation @C#@rpc]. По умолчанию методы не подвергаются воздействию ОКП. Может вернуться OK Если он будет зовом удачным, ERR_INVALID_PARAMETER если аргументы, изложенные в method не совпадать, ERR_UNCONFIGURED если сущность Entity.Multiplayer не могут быть доставлены (например, когда сущность не находится внутри дерева), ERR_CONNECTION_ERROR если Entity.Multiplayer'связь отсутствует. Примечание: Вы можете безопасно использовать RPC на клиентах только после получения MultiplayerApi.ConnectedToServer сигнал от MultiplayerApiВы также должны следить за состоянием соединения, либо с помощью MultiplayerApi такие сигналы, как MultiplayerApi.ServerDisconnected либо путем проверки (get_multiplayer().peer.get_connection_status() == CONNECTION_CONNECTED).

public Error Rpc(StringName method, ReadOnlySpan<Variant> args);

Посылает запрос на дистанционную процедуру method Запрос о вызове будет получен только узлами с теми же возможностями. EntityPath, включая то же самое Entity.NameПоведение зависит от конфигурации ОКП для данного method (см. Entity.RpcConfig и [annotation @C#@rpc]. По умолчанию методы не подвергаются воздействию ОКП. Может вернуться OK Если он будет зовом удачным, ERR_INVALID_PARAMETER если аргументы, изложенные в method не совпадать, ERR_UNCONFIGURED если сущность Entity.Multiplayer не могут быть доставлены (например, когда сущность не находится внутри дерева), ERR_CONNECTION_ERROR если Entity.Multiplayer'связь отсутствует. Примечание: Вы можете безопасно использовать RPC на клиентах только после получения MultiplayerApi.ConnectedToServer сигнал от MultiplayerApiВы также должны следить за состоянием соединения, либо с помощью MultiplayerApi такие сигналы, как MultiplayerApi.ServerDisconnected либо путем проверки (get_multiplayer().peer.get_connection_status() == CONNECTION_CONNECTED).

public void RpcConfig(StringName method, Variant config);

Изменяет конфигурацию ОТС для данного method. config должны быть либо null отключать функцию (как по умолчанию) или Reckfell.Collections.Dictionary с следующими позициями:

• rpc_modeСм. MultiplayerApi.RpcMode;
• transfer_modeСм. MultiplayerPeer.TransferModeEnum;
• call_local:: если true, этот метод будет также называться на местном уровне;
• channel:: a [int] представляющего канал для отправки ОКСР. Примечание: В C# этот метод соответствует [Аннотация @C#@rpc] с различными параметрами, переданными (@rpc(any), @rpc(authority)...) См. многопользователь высокого уровня Наставник.

public Error RpcId(long peerId, StringName method, params Variant[] args);

Отправляет Entity.Rpc определенному одноранговому сущности, идентифицированному peer_id (см. MultiplayerPeer.SetTargetPeer). Может возвращать OK, если вызов успешен, ERR_INVALID_PARAMETER, если аргументы, переданные в method, не совпадают, ERR_UNCONFIGURED, если Entity.Multiplayer сущности не может быть извлечен (например, когда сущность не находится внутри дерева), ERR_CONNECTION_ERROR, если соединение Entity.Multiplayer недоступно.

public Error RpcId(long peerId, StringName method, ReadOnlySpan<Variant> args);

Отправляет Entity.Rpc определенному одноранговому сущности, идентифицированному peer_id (см. MultiplayerPeer.SetTargetPeer). Может возвращать OK, если вызов успешен, ERR_INVALID_PARAMETER, если аргументы, переданные в method, не совпадают, ERR_UNCONFIGURED, если Entity.Multiplayer сущности не может быть извлечен (например, когда сущность не находится внутри дерева), ERR_CONNECTION_ERROR, если соединение Entity.Multiplayer недоступно.

public void SetDeferredThreadGroup(StringName property, Variant value);

Аналогично Entity.CallDeferredThreadGroup, но для настройки свойств.

public void SetDisplayFolded(bool fold);

Если установлено значение true, сущность отображается свернутым в Сценический док. В результате все его дочерние элементы скрыты. Этот метод предназначен для использования в плагинах и инструментах редактора, но он также работает в сборках релиза. См. также Entity.IsDisplayedFolded.

public void SetEditableInstance(Entity node, bool isEditable);

Установите значение true, чтобы разрешить всем узлам, принадлежащим node, быть доступными и редактируемыми в доке сцены, даже если их Entity.Owner не является корнем сцены. Этот метод предназначен для использования в плагинах и инструментах редактора, но он также работает в сборках релиза. См. также Entity.IsEditableInstance.

public void SetMultiplayerAuthority(int id, bool recursive = true);

Назначает peer с правом authority для этой сущности и, при recursive, потомков. Сам по себе не синхронизирует назначение на всех участниках и не проверяет аккаунт.

public void SetOwner(Entity owner);

Назначает предка владельцем сохраняемой Entity. Вызывайте после добавления в иерархию; не назначайте Entity самой себе и не ломайте области вложенных префабов.

public void SetPhysicsProcess(bool enable);

Переключает _PhysicsProcess этого объекта, отдельно от обычного callback. Отключение не является удалением тела из физического мира или очисткой его коллизий.

public void SetPhysicsProcessInternal(bool enable);

Если установлено значение true, включает внутреннюю физику для этого сущности. Внутренняя обработка физики происходит изолированно от обычных вызовов Entity._PhysicsProcess и используется некоторыми узлами внутренне, чтобы гарантировать правильное функционирование, даже если сущность приостановлен или обработка физики отключена для скриптинга (Entity.SetPhysicsProcess). Предупреждение: Встроенные сущности полагаются на внутреннюю обработку для своей внутренней логики. Отключение ее небезопасно и может привести к неожиданному поведению. Используйте этот метод, если вы знаете, что делаете.

public void SetProcess(bool enable);

Переключает обычный _Process этого объекта, отдельно от _PhysicsProcess. Не отключает автоматически все дочерние сигналы; pause/ProcessMode также влияют на фактический вызов.

public void SetProcessInput(bool enable);

В случае установки true, позволяет обрабатывать входные данные. Примечание: Если Entity._Input отключается, это будет автоматически включено до Entity.Ready зовутся. Input Уже предусмотрена обработка данных для контроля ГУИ, например Button и TextEdit.

public void SetProcessInternal(bool enable);

Если установлено значение true, включает внутреннюю обработку для этого сущности. Внутренняя обработка происходит изолированно от обычных вызовов Entity._Process и используется некоторыми узлами внутренне, чтобы гарантировать надлежащую работу, даже если сущность приостановлен или обработка отключена для скриптинга (Entity.SetProcess). Предупреждение: Встроенные сущности полагаются на внутреннюю обработку для своей внутренней логики. Отключение ее небезопасно и может привести к неожиданному поведению. Используйте этот метод, если вы знаете, что делаете.

public void SetProcessShortcutInput(bool enable);

Если установлено значение true, включает обработку сокращений для этого сущности. Примечание: Если Entity._ShortcutInput переопределен, он будет автоматически включен перед вызовом Entity.Ready.

public void SetProcessUnhandledInput(bool enable);

Если установлено значение true, включается обработка необработанного ввода. Это позволяет сущности получать весь ввод, который ранее не был обработан (обычно Control). Примечание: Если Entity._UnhandledInput переопределен, он будет автоматически включен до вызова Entity.Ready. Обработка необработанного ввода также уже включена для элементов управления GUI, таких как Button и TextEdit.

public void SetProcessUnhandledKeyInput(bool enable);

Если установлено значение true, включается обработка необработанного ввода клавиш. Примечание: Если Entity._UnhandledKeyInput переопределен, он будет автоматически включен перед вызовом Entity.Ready.

public void SetSceneInstanceLoadPlaceholder(bool loadPlaceholder);

Если установлено значение true, сущность становится InstancePlaceholder при упаковке и создании экземпляра из PackedEntity. См. также Entity.GetSceneInstanceLoadPlaceholder.

public void SetThreadSafe(StringName property, Variant value);

Аналогично Entity.CallThreadSafe, но для настройки свойств.

public void SetTranslationDomainInherited();

Делает так, чтобы этот сущность наследовал домен перевода от своего родительского сущности. Если у этого сущности нет родителя, будет использоваться основной домен перевода. Это поведение по умолчанию для всех сущностей. Вызов ReckfellObject.SetTranslationDomain отключает это поведение.

public void UpdateConfigurationWarnings();

Обновляет предупреждения, отображаемые для этого сущности в доке сцены. Используйте Entity._GetConfigurationWarnings для настройки отображаемых предупреждающих сообщений.

public virtual void _EnterTree();

Вызывается при каждом входе в активное дерево, прежде обычного входа детей. Подходит для симметричной подписки с отпиской в _ExitTree.

public virtual void _ExitTree();

Вызывается при выходе, после детей. Снимайте внешние подписки; выход не всегда означает удаление объекта.

public virtual string[] _GetAccessibilityConfigurationWarnings();

Элементы в массиве, возвращаемые этим методом, отображаются как предупреждения в доке сцены, если скрипт, который его переопределяет, является скриптом tool, а предупреждения о доступности включены в настройках редактора. Возврат пустого массива не приводит к появлению предупреждений.

public virtual string[] _GetConfigurationWarnings();

Элементы в массиве, возвращаемые этим методом, отображаются как предупреждения в доке сцены, если скрипт, который его переопределяет, является скриптом tool. Возврат пустого массива не приводит к появлению предупреждений. Вызовите Entity.UpdateConfigurationWarnings, когда предупреждения необходимо обновить для этого сущности.

public virtual Rid _GetFocusedAccessibilityElement();

Вызывается во время обновления информации о доступности для определения текущего сфокусированного подэлемента, должен возвращать RID подэлемента или значение, возвращаемое Entity.GetAccessibilityElement.

public virtual void _Input(InputEvent @event);

Вызывается при наличии события ввода. Событие ввода распространяется вверх по дереву сущностей, пока сущность не потребит его. Вызывается только в том случае, если включена обработка ввода, что выполняется автоматически, если этот метод переопределен, и может быть переключено с помощью Entity.SetProcessInput. Чтобы потребить событие ввода и остановить его дальнейшее распространение на другие сущности, можно вызвать Viewport.SetInputAsHandled. Для игрового ввода обычно лучше подходят Entity._UnhandledInput и Entity._UnhandledKeyInput, поскольку они позволяют графическому интерфейсу сначала перехватывать события. Примечание: Этот метод вызывается только в том случае, если сущность присутствует в дереве сцены (т. е. если он не является сиротой).

public virtual void _PhysicsProcess(double delta);

Вызывается на фиксированном шаге физики. delta — длительность шага в секундах. Здесь обновляют скорость CharacterBody2D или CharacterBody3D и вызывают MoveAndSlide(). Частота физики задаётся настройками проекта и не равна частоте отрисовки.

public virtual void _Process(double delta);

Вызывается каждый отрисовываемый кадр при включённой обработке. delta — время с предыдущего кадра в секундах. Умножайте скорость на delta для перемещения с одинаковой скоростью при разной частоте кадров. Физическое движение выполняйте в _PhysicsProcess().

public virtual void _Ready();

Вызывается после готовности обычных детей; без RequestReady автоматически не повторяется при повторном входе. Не обещает готовность будущих объектов и внешних служб.

public virtual void _ShortcutInput(InputEvent @event);

Вызывается, когда InputEventKey, InputEventShortcut или InputEventJoypadButton не были использованы Entity._Input или любым элементом GUI Control. Вызывается до Entity._UnhandledKeyInput и Entity._UnhandledInput. Событие ввода распространяется вверх по дереву сущностей, пока сущность не потребит его. Вызывается только в том случае, если включена обработка сочетаний клавиш, что выполняется автоматически, если этот метод переопределен, и может быть переключено с помощью Entity.SetProcessShortcutInput. Чтобы использовать событие ввода и остановить его дальнейшее распространение на другие сущности, можно вызвать Viewport.SetInputAsHandled. Этот метод можно использовать для обработки сочетаний клавиш. Для общих событий GUI используйте вместо этого Entity._Input. События игрового процесса обычно следует обрабатывать с помощью Entity._UnhandledInput или Entity._UnhandledKeyInput. Примечание: Этот метод вызывается только в том случае, если сущность присутствует в дереве сцены (т. е. если он не является сиротским).

public virtual void _UnhandledInput(InputEvent @event);

Вызывается, когда InputEvent не был использован Entity._Input или любым элементом GUI Control. Он вызывается после Entity._ShortcutInput и после Entity._UnhandledKeyInput. Событие ввода распространяется вверх по дереву сущностей, пока сущность не использует его. Он вызывается только в том случае, если включена обработка необработанного ввода, что выполняется автоматически, если этот метод переопределен, и может быть переключено с помощью Entity.SetProcessUnhandledInput. Чтобы использовать событие ввода и остановить его дальнейшее распространение на другие сущности, можно вызвать Viewport.SetInputAsHandled. Для игрового ввода этот метод обычно подходит лучше, чем Entity._Input, так как событиям GUI требуется более высокий приоритет. Для сочетаний клавиш рассмотрите возможность использования Entity._ShortcutInput, так как он вызывается перед этим методом. Наконец, для обработки событий клавиатуры рассмотрите возможность использования Entity._UnhandledKeyInput из соображений производительности. Примечание: Этот метод вызывается только в том случае, если сущность присутствует в дереве сцены (т. е. если он не является сиротой).

public virtual void _UnhandledKeyInput(InputEvent @event);

Вызывается, когда InputEventKey не был использован Entity._Input или любым элементом GUI Control. Вызывается после Entity._ShortcutInput, но до Entity._UnhandledInput. Событие ввода распространяется вверх по дереву сущностей, пока сущность не потребит его. Вызывается только в том случае, если включена обработка необработанного ввода клавиш, что выполняется автоматически, если этот метод переопределен, и может быть переключено с помощью Entity.SetProcessUnhandledKeyInput. Чтобы использовать событие ввода и остановить его дальнейшее распространение на другие сущности, можно вызвать Viewport.SetInputAsHandled. Этот метод можно использовать для обработки ввода символов Unicode с модификаторами [kbd]Alt[/kbd], [kbd]Alt + Ctrl[/kbd] и [kbd]Alt + Shift[/kbd] после обработки сочетаний клавиш. Для игрового ввода этот и Entity._UnhandledInput обычно подходят лучше, чем Entity._Input, так как события GUI должны обрабатываться в первую очередь. Этот метод также работает лучше, чем Entity._UnhandledInput, так как несвязанные события, такие как InputEventMouseMotion, автоматически фильтруются. Для сочетаний клавиш рассмотрите возможность использования Entity._ShortcutInput. Примечание: Этот метод вызывается только в том случае, если сущность присутствует в дереве сцены (т. е. если он не является сиротой).

public event Entity.ChildEnteredTreeEventHandler ChildEnteredTree;

Выдается, когда дочерний node входит в EntityTree, обычно потому, что этот сущность вошел в дерево (см. Entity.TreeEntered) или был вызван Entity.AddChild. Этот сигнал выдается после собственных Entity.NotificationEnterTree и Entity.TreeEntered дочернего сущности.

public event Entity.ChildExitingTreeEventHandler ChildExitingTree;

Выдается, когда дочерний node собирается выйти из EntityTree, обычно потому что этот сущность выходит из дерева (см. Entity.TreeExiting) или потому что дочерний node удаляется или освобождается. Когда этот сигнал получен, дочерний node все еще доступен внутри дерева. Этот сигнал выдается после собственного Entity.TreeExiting и Entity.NotificationExitTree дочернего сущности.

public event Action ChildOrderChanged;

Выдается при изменении списка дочерних сущностей. Это происходит при добавлении, перемещении или удалении дочерних сущностей.

public event Entity.EditorDescriptionChangedEventHandler EditorDescriptionChanged;

Генерируется при изменении поля описания сущности.

public event Action EditorStateChanged;

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