Руководство API скрипты

NavMeshAgent

класс в UnityEngine.AI / Наследует от: Behaviour / Реализует: UnityEngine.AIModule

Описание

Агент навигационной сетки.

Этот компонент прикреплен к мобильному персонажу в игре, чтобы позволить ему перемещаться по сцене с помощью NavMesh. Дополнительную информацию см. в разделе «Навигация» руководства.

Свойства

acceleration Максимальное ускорение агента при следовании по пути, выраженное в единицах / сек^2.
agentTypeID ID для агента.
angularSpeed Максимальная скорость поворота в (град/сек) при движении по траектории.
areaMask Указывает, какие области NavMesh проходимы. Изменение areaMask сделает путь устаревшим (см. isPathStale).
autoBraking Должен ли агент автоматически тормозить, чтобы избежать превышения точки назначения?
autoRepath Должен ли агент пытаться получить новый путь, если существующий путь становится недействительным?
autoTraverseOffMeshLink Должен ли агент автоматически перемещаться через OffMeshLinks?
avoidancePriority Уровень приоритета предотвращения.
baseOffset Относительное вертикальное смещение владельца игрового объекта.
currentOffMeshLinkData Текущий OffMeshLinkData.
desiredVelocity Желаемая скорость агента, включая любой потенциальный вклад от уклонения. (Только чтение)
destination Получает или пытается установить пункт назначения агента в единицах измерения мирового пространства.
hasPath Есть ли в настоящее время путь у агента? (Только чтение)
height Высота агента для прохождения под препятствиями и т. д.
isOnNavMesh Привязан ли агент к навигационной сетке navmesh? (Только чтение)
isOnOffMeshLink Находится ли агент в настоящее время на OffMeshLink? (Только чтение)
isPathStale Текущий путь устарел. (Только чтение)
isStopped Это свойство содержит условие остановки или возобновления работы агента NavMesh.
navMeshOwner Возвращает объект-владелец NavMesh, на котором в данный момент размещен агент (только для чтения).
nextOffMeshLinkData Следующий OffMeshLinkData на текущем пути.
nextPosition Получает или задает позицию моделирования агента навигационной сетки.
obstacleAvoidanceType Уровень качества избегания.
path Свойство для получения и установки текущего пути.
pathPending Путь находится в процессе вычисления, но еще не готов? (Только чтение)
pathStatus Статус текущего пути (полный, частичный или неверный).
radius Радиус уклонения от агента.
remainingDistance Расстояние между позицией агента и пунктом назначения на текущем пути. (Только чтение)
speed Максимальная скорость движения при следовании по пути.
steeringTarget Получить текущую цель управления по пути. (Только чтение)
stoppingDistance Остановиться на указанном расстоянии от целевой позиции.
updatePosition Получает или задает значение, указывающее, синхронизируется ли позиция преобразования с симулируемой позицией агента. Значение по умолчанию true.
updateRotation Должен ли агент обновлять ориентацию преобразования(transform)?
updateUpAxis Позволяет указать, должен ли агент быть выровнен по верхней оси NavMesh или по ссылке, на которой он размещен.
velocity Получаете доступ к текущей скорости компонента NavMeshAgent или установите скорость для управления агентом вручную.

Публичные Методы

ActivateCurrentOffMeshLink Включает или отключает текущую ссылку вне сетки.
CalculatePath Вычислить путь к указанной точке и сохранить полученный путь.
CompleteOffMeshLink Завершает движение по текущему OffMeshLink.
FindClosestEdge Находит ближайшее ребро NavMesh.
GetAreaCost Получает стоимость расчета пути при пересечении области определенного типа.
Move Применить относительное перемещение к текущей позиции.
Raycast Прослеживает прямой путь к целевой позиции в NavMesh, не перемещая агента.
ResetPath Очищает текущий путь.
SamplePathPosition Выбирает позицию вдоль текущего пути.
SetAreaCost Устанавливает стоимость обхода областей площадного типа.
SetDestination Устанавливает или обновляет пункт назначения, запуская таким образом расчет нового пути.
SetPath Назначает новый путь данному агенту.
Warp Деформирует агента в указанную позицию.

Унаследованные члены

Свойства

enabled Включенные поведения обновляются, отключенные — нет.
isActiveAndEnabled Было ли поведение активным и включенным?
gameObject Игровой объект, к которому прикреплен компонент. Компонент всегда привязан к игровому объекту.
tag Тег игрового объекта.
transform Transform, прикрепленный игровому объекту.
hideFlags Должен ли объект быть скрыт, сохранен вместе со сценой или изменен пользователем?
name Имя объекта

Публичные Методы

BroadcastMessage Вызывает метод с именем methodName для каждого MonoBehaviour в игровом объекте или любом из его дочерних элементов.
CompareTag Помечен ли этот игровой объект тегом?
GetComponent Возвращает компонент, если он прикреплён к игровому объекту, и null, если нет. Также возвращает отключенные компоненты.
GetComponentInChildren Возвращает компонент дочернего элемента игрового объекта, используя поиск в глубину.
GetComponentInParent Возвращает компонент игрового объекта в любом из его родителей.
GetComponents Возвращает все компоненты игрового объекта
GetComponentsInChildren Возвращает все компоненты дочерних элементов игрового объекта. Работает рекурсивно.
GetComponentsInParent Возвращает все компоненты игрового объекта любого из родителя.
SendMessage Вызывает метод с именем methodName для каждого MonoBehaviour в этом игровом объекте.
SendMessageUpwards Вызывает метод с именем methodName для каждого MonoBehaviour в этом игровом объекте и для каждого behaviour.
TryGetComponent Получает компонент указанного типа, если он существует.
GetInstanceID Возвращает идентификатор экземпляра объекта.
ToString Возвращает имя объекта.

Статические Методы

Destroy Удаляет игровой объект, компонент или актив.
DestroyImmediate Уничтожает объект obj. Настоятельно рекомендуется использовать Destroy.
DontDestroyOnLoad Не уничтожает целевой объект при загрузке новой сцены.
FindObjectOfType Возвращает первый активный загруженный объект.
FindObjectsOfType Получает список всех загруженных объектов.
Instantiate Клонирует исходный объект и возвращает клон.

Операторы

bool Объект существует?
operator != Сравнивает, ссылаются ли два объекта на другой объект.
operator == Сравнивает две ссылки на объекты, чтобы определить, ссылаются ли они на один и тот же объект.
Вы можете отблагодарить автора, за перевод документации на русский язык. Донат
API скрипты 2021.3