NavigationAgent2D

public bool AvoidanceEnabled { get; set; }

Включает расчёт избегания. Передавайте желаемую Velocity и применяйте скорость из VelocityComputed к телу. Сам флаг не выполняет движение и не гарантирует обход любых препятствий.

public uint AvoidanceLayers { get; set; }

Ударное поле, определяющее уровни избегания для этого навигационного агента. NavigationAgent2D.AvoidanceMask избегает этого агента.

public uint AvoidanceMask { get; set; }

Ударное поле, определяющее, какие другие агенты избегают и препятствия этот Навигационный Агент избежит, когда немного совпадет, по крайней мере, один из их NavigationAgent2D.AvoidanceLayers.

public float AvoidancePriority { get; set; }

Агент не корректирует скорость для других агентов, которые соответствуют NavigationAgent2D.AvoidanceMask, но имеют более низкий NavigationAgent2D.AvoidancePriority. Это, в свою очередь, заставляет других агентов с более низким приоритетом корректировать свои скорости еще больше, чтобы избежать столкновения с этим агентом.

public bool DebugEnabled { get; set; }

Если true, отображаются визуальные отладочные данные для этого агента.

public Color DebugPathCustomColor { get; set; }

Если NavigationAgent2D.DebugUseCustom равен true, то этот цвет используется для этого агента вместо глобального цвета.

public float DebugPathCustomLineWidth { get; set; }

Если NavigationAgent2D.DebugUseCustom равен true, то эта ширина линии используется для отрисовки путей для этого агента вместо глобальной ширины линии.

public float DebugPathCustomPointSize { get; set; }

Если NavigationAgent2D.DebugUseCustom равен true, то для рендеринга точек пути этого агента, вместо глобального размера точки, используется этот растеризованный размер точки.

public bool DebugUseCustom { get; set; }

Если true, то вместо глобального цвета используется определенный NavigationAgent2D.DebugPathCustomColor для этого агента.

public int MaxNeighbors { get; set; }

Максимальное количество соседей, которых может учитывать агент.

public float MaxSpeed { get; set; }

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

public uint NavigationLayers { get; set; }

Маска поверхностей и связей для маршрута агента. Любой общий бит допускает соответствующий регион; это не условие наличия всех ключей. Изменение при активной цели запрашивает перестроение пути, что проверено переключением 1 → 0 → 1.

public float NeighborDistance { get; set; }

Расстояние для поиска других агентов.

public float PathDesiredDistance { get; set; }

Допуск подхода к очередной точке пути в единицах карты. Подбирайте под скорость и шаг физики: слишком малый допуск может вызвать перескок и возврат к точке.

public float PathMaxDistance { get; set; }

Максимальное расстояние, на которое агент может отойти от идеального пути до конечной позиции. Это может произойти из-за попыток избежать столкновений. При превышении максимального расстояния он пересчитывает идеальный путь.

public NavigationPathQueryParameters2D.PathMetadataFlags PathMetadataFlags { get; set; }

Дополнительная информация для возврата по пути навигации.

public NavigationPathQueryParameters2D.PathPostProcessing PathPostprocessing { get; set; }

Постобработка пути, примененная к необработанному коридору пути, найденному NavigationAgent2D.PathfindingAlgorithm.

public float PathReturnMaxLength { get; set; }

Максимально допустимая длина возвращаемого пути в мировых единицах. При превышении этой длины путь будет обрезан.

public float PathReturnMaxRadius { get; set; }

Максимально допустимый радиус возвращаемого пути от начала пути в мировых единицах. При превышении этого радиуса путь будет обрезан. По сравнению с NavigationAgent2D.PathReturnMaxLength, это позволяет агенту пройти значительно больше, если ему потребуется обойти угол. Примечание: При этом будет выполнено обрезание сферы с учётом только фактических точек пути навигационной сетки, при этом первая точка пути будет находиться в центре сферы.

public float PathSearchMaxDistance { get; set; }

Максимальное расстояние, на которое может отдалиться искомый полигон от начального полигона, прежде чем поиск пути отменит поиск пути к целевому полигону (возможно, недостижимому или очень удалённому). В этом случае поиск пути сбрасывается и строит путь от начального полигона до полигона, который был найден ближайшим к целевой позиции. Значение 0 или ниже считается неограниченным. В случае неограниченного значения поиск пути будет искать все полигоны, соединённые с начальным полигоном, пока не будет найден целевой полигон или пока не будут исчерпаны все доступные варианты поиска полигонов.

public int PathSearchMaxPolygons { get; set; }

Максимальное количество полигонов, которые будут просмотрены до того, как поиск пути отменит поиск пути к целевому полигону (возможно, недостижимому или очень удалённому). В этом случае поиск пути сбрасывается и строит путь от начального полигона до полигона, который был найден ближайшим к целевой позиции. Значение 0 или меньше считается неограниченным. В случае неограниченного поиска пути поиск пути будет искать все полигоны, соединённые с начальным полигоном, пока не будет найден целевой полигон или пока не будут исчерпаны все доступные варианты поиска полигонов.

public NavigationPathQueryParameters2D.PathfindingAlgorithmEnum PathfindingAlgorithm { get; set; }

Алгоритм поиска пути, используемый в запросе пути.

Радиус

public float Radius { get; set; }

Радиус круга агента для избегания. Не меняет физический коллайдер и не перезапекает навигационный меш под другой размер персонажа.

public float SimplifyEpsilon { get; set; }

Упрощение пути в мировых единицах.

public bool SimplifyPath { get; set; }

Если true, будет возвращена упрощенная версия пути с удаленными менее критическими точками пути. Степень упрощения контролируется NavigationAgent2D.SimplifyEpsilon. Упрощение использует вариант алгоритма Ramer-Douglas-Peucker для прореживания точек кривой. Упрощение пути может быть полезно для смягчения различных проблем следования по пути, которые могут возникнуть с определенными типами агентов и поведением сценария. Например, «рулевое управление» или избегание в «открытых полях».

public float TargetDesiredDistance { get; set; }

Допуск достижения исходной цели и сравнения конца найденного пути с целью. Большое значение может завершить маршрут раньше ожидаемого.

public Vector2 TargetPosition { get; set; }

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

public float TimeHorizonAgents { get; set; }

Минимальное количество времени, в течение которого скорость этого агента, рассчитанная с помощью алгоритма предотвращения столкновения, безопасна по отношению к другим агентам. Чем больше число, тем быстрее агент будет реагировать на другие агенты, но меньше свободы в выборе скорости. Слишком высокое значение значительно замедляет движение агента. Должно быть положительным.

public float TimeHorizonObstacles { get; set; }

Минимальное количество времени, в течение которого скорость этого агента, рассчитанная с помощью алгоритма предотвращения столкновения, безопасна с точки зрения статических препятствий. Чем больше число, тем быстрее агент будет реагировать на статические преграды, но меньше свободы в выборе скорости. Слишком высокое значение значительно замедляет движение агента. Должно быть положительным.

public Vector2 Velocity { get; set; }

Желаемая скорость для расчёта избегания, в единицах карты в секунду. Не умножайте её на delta при передаче затем в CharacterBody2D.MoveAndSlide. Итоговая скорость приходит через VelocityComputed.

public float DistanceToTarget();

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

public bool GetAvoidanceLayerValue(int layerNumber);

Возвращается ли указанный слой NavigationAgent2D.AvoidanceLayers Включена битмаска, при условии a layer_number от 1 до 32 лет.

public bool GetAvoidanceMaskValue(int maskNumber);

Возвращается ли указанная маска NavigationAgent2D.AvoidanceMask Включена битмаска, при условии a mask_number от 1 до 32 лет.

public Vector2[] GetCurrentNavigationPath();

Читает текущий массив пути агента. Не перемещает тело; точки могут закончиться у доступной границы, а не у исходной цели.

public int GetCurrentNavigationPathIndex();

Возвращает индекс, по которому в данный момент находится агент в массиве Vector2[] пути навигации.

public NavigationPathQueryResult2D GetCurrentNavigationResult();

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

public Vector2 GetFinalPosition();

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

public bool GetNavigationLayerValue(int layerNumber);

Возвращает, включен ли указанный слой битовой маски NavigationAgent2D.NavigationLayers, учитывая layer_number от 1 до 32.

public uint GetNavigationLayers();

Читает маску запросов агента. Она не описывает размер тела или радиус избегания.

public Rid GetNavigationMap();

Возвращает явную карту агента, а без неё — карту мира его корректного родителя. Локально назначенная карта Entity может обновиться раньше серверной очереди.

public Vector2 GetNextPathPosition();

Обновляет состояние агента и возвращает следующую точку. Используйте её в цикле физики для собственного движения родителя; после завершения маршрута остановите следование.

public float GetPathLength();

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

public Rid GetRid();

Возвращает Rid этого агента на NavigationServer2D.

public bool IsNavigationFinished();

Обновляет состояние навигации и сообщает о завершении текущего маршрута. Частичный путь тоже может завершиться: проверяйте IsTargetReached отдельно.

public bool IsTargetReachable();

Обновляет навигацию и сравнивает найденный конец с целью по TargetDesiredDistance. Проверяйте наличие текущего пути; метод не гарантирует прохождение физического тела сквозь реальный уровень.

public bool IsTargetReached();

Читает сохранённый признак достижения цели с допуском TargetDesiredDistance. Признак обновляется логикой следования пути; это не прямой физический тест доступности.

public void SetAvoidanceLayerValue(int layerNumber, bool value);

На основе value включает или отключает указанный слой в битовой маске NavigationAgent2D.AvoidanceLayers, учитывая layer_number от 1 до 32.

public void SetAvoidanceMaskValue(int maskNumber, bool value);

На основе value включает или отключает указанную маску в битовой маске NavigationAgent2D.AvoidanceMask, учитывая mask_number от 1 до 32.

public void SetNavigationLayerValue(int layerNumber, bool value);

На основе value включает или отключает указанный слой в битовой маске NavigationAgent2D.NavigationLayers, учитывая layer_number от 1 до 32.

public void SetNavigationLayers(uint navigationLayers);

Маска поверхностей и связей для маршрута агента. Любой общий бит допускает соответствующий регион; это не условие наличия всех ключей. Изменение при активной цели запрашивает перестроение пути, что проверено переключением 1 → 0 → 1.

public void SetNavigationMap(Rid navigationMap);

Назначает карту для запросов Entity агента и отправляет смену карты его серверному агенту. При активной цели сбрасывает текущий результат для нового поиска. Это не переключатель только геометрии: учитывайте изоляцию избегания по картам.

public void SetVelocityForced(Vector2 velocity);

Заменяет внутреннюю скорость в моделировании избегания столкновений на NavigationAgent2D.Velocity. Когда агент телепортируется в новое положение, эта функция должна использоваться в том же кадре. При частом вызове эта функция может привести к застреванию агентов.

public event NavigationAgent2D.LinkReachedEventHandler LinkReached;

Сигнализирует, что агент достиг навигационной ссылки (Link). Выдается, когда агент перемещается в пределах NavigationAgent2D.PathDesiredDistance от следующей позиции пути, когда эта позиция является навигационной ссылкой. Словарь сведений может содержать следующие ключи в зависимости от значения NavigationAgent2D.PathMetadataFlags:

• position: начальная позиция достигнутой ссылки.
• type: всегда NavigationPathQueryResult2D.PathSegmentType.Link.
• rid: Rid ссылки.
• owner: объект, управляющий ссылкой (обычно NavigationLink2D).
• link_entry_position: Если доступен owner и владелец — NavigationLink2D, он будет содержать глобальную позицию точки ссылки, в которую входит агент.
• link_exit_position: Если доступен owner и владелец — NavigationLink2D, он будет содержать глобальную позицию точки ссылки, из которой выходит агент.

public event Action NavigationFinished;

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

public event Action PathChanged;

Выдается, когда агенту необходимо обновить загруженный путь:

• потому что путь ранее был пуст.
• потому что карта навигации изменилась.
• потому что агент оттолкнулся от текущего сегмента пути дальше, чем NavigationAgent2D.PathMaxDistance.

public event Action TargetReached;

Сигнализирует о том, что агент достиг цели, т. е. агент переместился в пределах NavigationAgent2D.TargetDesiredDistance от NavigationAgent2D.TargetPosition. Этот сигнал посылается только один раз на загруженный путь. Этот сигнал будет посылаться непосредственно перед NavigationAgent2D.NavigationFinished, когда цель достижима. Не всегда возможно достичь цели, но всегда должно быть возможно достичь конечной позиции. См. NavigationAgent2D.GetFinalPosition.

public event NavigationAgent2D.VelocityComputedEventHandler VelocityComputed;

Уведомляет, когда вычисляется скорость избегания столкновений. Выпускается каждое обновление, пока NavigationAgent2D.AvoidanceEnabled имеет значение true и у агента есть навигационная карта.

public event NavigationAgent2D.WaypointReachedEventHandler WaypointReached;

Сигнализирует о том, что агент достиг путевой точки. Выдается, когда агент перемещается в пределах NavigationAgent2D.PathDesiredDistance от следующей позиции пути. Словарь сведений может содержать следующие ключи в зависимости от значения NavigationAgent2D.PathMetadataFlags:

• position: позиция путевой точки, которая была достигнута.
• type: тип навигационного примитива (регион или ссылка), который содержит эту путевую точку.
• rid: Rid содержащего навигационного примитива (регион или ссылка).
• owner: объект, который управляет содержащим навигационным примитивом (регион или ссылка).