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

CompositeCollider2D

к Руководству

класс в UnityEngine / Наследует от: Collider2D / Реализовано в: UnityEngine.Physics2DModule

Описание

Коллайдер, который может объединять другие коллайдеры.

Компонент CompositeCollider2D объединяет другие коллайдеры вместе, если для их Collider2D.usedByComposite задано значение true.

Когда коллайдер используется составным коллайдером, редактор игнорирует и не отображает Collider2D.sharedMaterial, Collider2D.isTrigger и свойства Collider2D.usedByComposite. Вместо этого будут использоваться те же свойства CompositeCollider2D. Вы должны установить эти свойства в составном коллайдере вместо того, чтобы объединить все коллайдеры в составной коллайдер.

Композитные коллайдеры могут объединять только BoxCollider2D и PolygonCollider2D.

Свойства

edgeRadius Управляет радиусом всех ребер, созданных коллайдером.
generationType Указывает, когда создавать геометрию композитного коллайдера.
geometryType Определяет тип геометрии, которую должен генерировать Composite Collider.
offsetDistance Вершины смещаются на это расстояние при компоновке нескольких физических фигур. Любые вершины между фигурами в пределах этого расстояния объединяются.
pathCount Количество путей в Коллайдере.
pointCount Получает общее количество точек на всех путях внутри коллайдера.
vertexDistance Управляет минимально допустимым расстоянием между сгенерированными вершинами.

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

GenerateGeometry Регенерирует геометрию композитного коллайдера.
GetPath Получает путь от Коллайдера по его индексу.
GetPathPointCount Получает количество точек на указанном пути от Коллайдера по его индексу.

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

Свойства

enabled Включенные поведения обновляются, отключенные — нет.
isActiveAndEnabled Было ли поведение активным и включенным?
attachedRigidbody Rigidbody2D, прикрепленный к Collider2D.
bounciness Получает упругость, используемую коллайдером.
bounds Мировое пространство, ограничивающее область коллайдера.
composite Получает CompositeCollider2D, доступный для присоединения к коллайдеру.
density Плотность коллайдера, используемая для расчета его массы (когда включена автоматическая масса).
friction Получает трение, используемое коллайдером.
isTrigger Настроен ли этот коллайдер как триггер?
offset Локальное смещение геометрии коллайдера.
shapeCount Количество отдельных областей формы в коллайдере.
sharedMaterial PhysicsMaterial2D, применяемый к этому коллайдеру.
usedByComposite Устанавливает, будет ли коллайдер использоваться или не использоваться CompositeCollider2D.
usedByEffector Используется ли коллайдер прикрепленным эффектором или нет.
gameObject Игровой объект, к которому прикреплен компонент. Компонент всегда привязан к игровому объекту.
tag Тег игрового объекта.
transform Transform, прикрепленный игровому объекту.
hideFlags Должен ли объект быть скрыт, сохранен вместе со сценой или изменен пользователем?
name Имя объекта

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

Cast Добавляет форму коллайдера в сцену, начиная с позиции коллайдера, игнорируя сам коллайдер.
ClosestPoint Возвращает точку на периметре этого коллайдера, ближайшую к указанной позиции.
CreateMesh Создает плоскую сетку, идентичную области, заданной геометрией Collider2D.
Distance Вычисляет минимальное расстояние между этим коллайдером и другим коллайдером.
GetContacts Извлекает все точки контакта для этого коллайдера.
GetShapeHash Генерирует простое хеш-значение на основе геометрии Collider2D.
IsTouching Проверяет, касается ли этот коллайдер коллайдера или нет.
IsTouchingLayers Проверяет, касается ли этот коллайдер каких-либо коллайдеров на указанной маске слоя или нет.
OverlapCollider Получает список всех коллайдеров, которые перекрывают этот коллайдер.
OverlapPoint Проверяет, не перекрывает ли коллайдер точку в пространстве.
Raycast Направляет в сцену луч, который начинается с позиции коллайдера и игнорирует сам коллайдер.
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 == Сравнивает две ссылки на объекты, чтобы определить, ссылаются ли они на один и тот же объект.

Сообщения

OnCollisionEnter2D Отправляется, когда входящий коллайдер вступает в контакт с коллайдером этого объекта (только для 2D-физики).
OnCollisionExit2D Отправляется, когда коллайдер другого объекта перестает касаться коллайдера этого объекта (только для 2D-физики).
OnCollisionStay2D Отправляется каждый кадр, в котором коллайдер другого объекта касается коллайдера этого объекта (только 2D-физика).
OnTriggerEnter2D Отправляется, когда другой объект входит в триггерный коллайдер, прикрепленный к этому объекту (только для 2D-физики).
OnTriggerExit2D Отправляется, когда другой объект покидает триггерный коллайдер, прикрепленный к этому объекту (только для 2D-физики).
OnTriggerStay2D Отправляется каждый кадр, в котором другой объект находится внутри триггерного коллайдера, прикрепленного к этому объекту (только 2D-физика).
Вы можете отблагодарить автора, за перевод документации на русский язык. Донат
API скрипты 2021.3