:github_url: hide .. _class_ShapeCast3D: ShapeCast3D =========== **Наследует:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` Трехмерная фигура, охватывающая область пространства для обнаружения :ref:`CollisionObject3D`-ов. .. rst-class:: classref-introduction-group Описание ---------------- Приведение формы позволяет обнаруживать объекты столкновения, перемещая его :ref:`shape` вдоль направления приведения, определяемого :ref:`target_position`. Это похоже на :ref:`RayCast3D`, но позволяет перемещать область пространства, а не просто прямую линию. **ShapeCast3D** может обнаруживать несколько объектов столкновения. Это полезно для таких вещей, как широкие лазерные лучи или привязка простой формы к полу. Немедленное перекрытие столкновений можно выполнить, установив :ref:`target_position` на ``Vector3(0, 0, 0)`` и вызвав :ref:`force_shapecast_update()` в том же физическом кадре. Это помогает преодолеть некоторые ограничения :ref:`Area3D` при использовании в качестве мгновенной области обнаружения, поскольку информация о столкновении не сразу доступна ему. \ **Примечание:** Приведение формы требует больших вычислительных затрат, чем приведение лучей. .. rst-class:: classref-reftable-group Свойства ---------------- .. table:: :widths: auto +-------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`collide_with_areas` | ``false`` | +-------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`collide_with_bodies` | ``true`` | +-------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`collision_mask` | ``1`` | +-------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`Array` | :ref:`collision_result` | ``[]`` | +-------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`debug_shape_custom_color` | ``Color(0, 0, 0, 1)`` | +-------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`enabled` | ``true`` | +-------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`exclude_parent` | ``true`` | +-------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`margin` | ``0.0`` | +-------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`max_results` | ``32`` | +-------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`Shape3D` | :ref:`shape` | | +-------------------------------+--------------------------------------------------------------------------------------+-----------------------+ | :ref:`Vector3` | :ref:`target_position` | ``Vector3(0, -1, 0)`` | +-------------------------------+--------------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-reftable-group Методы ------------ .. table:: :widths: auto +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_exception`\ (\ node\: :ref:`CollisionObject3D`\ ) | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_exception_rid`\ (\ rid\: :ref:`RID`\ ) | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_exceptions`\ (\ ) | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`force_shapecast_update`\ (\ ) | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_closest_collision_safe_fraction`\ (\ ) |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_closest_collision_unsafe_fraction`\ (\ ) |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_collider`\ (\ index\: :ref:`int`\ ) |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_collider_rid`\ (\ index\: :ref:`int`\ ) |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collider_shape`\ (\ index\: :ref:`int`\ ) |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collision_count`\ (\ ) |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_collision_normal`\ (\ index\: :ref:`int`\ ) |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_collision_point`\ (\ index\: :ref:`int`\ ) |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_colliding`\ (\ ) |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_exception`\ (\ node\: :ref:`CollisionObject3D`\ ) | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_exception_rid`\ (\ rid\: :ref:`RID`\ ) | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`resource_changed`\ (\ resource\: :ref:`Resource`\ ) | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_collision_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Описания свойств -------------------------------- .. _class_ShapeCast3D_property_collide_with_areas: .. rst-class:: classref-property :ref:`bool` **collide_with_areas** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_collide_with_areas**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_collide_with_areas_enabled**\ (\ ) Если ``true``, будут сообщаться о столкновениях с :ref:`Area3D`-ми. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_property_collide_with_bodies: .. rst-class:: classref-property :ref:`bool` **collide_with_bodies** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_collide_with_bodies**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_collide_with_bodies_enabled**\ (\ ) Если ``true``, будут сообщаться о столкновениях с :ref:`PhysicsBody3D`-ми. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_property_collision_mask: .. rst-class:: classref-property :ref:`int` **collision_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_collision_mask**\ (\ ) Маска столкновения формы. Будут обнаружены только те объекты, находящиеся хотя бы в одном из слое столкновения, включенном в маске. Для получения дополнительной информации см. `Слои и маски столкновения <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ в документации. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_property_collision_result: .. rst-class:: classref-property :ref:`Array` **collision_result** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`Array` **get_collision_result**\ (\ ) Возвращает полную информацию о столкновении из столкновительного развертки. Возвращаемые данные такие же, как в методе :ref:`PhysicsDirectSpaceState3D.get_rest_info()`. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_property_debug_shape_custom_color: .. rst-class:: classref-property :ref:`Color` **debug_shape_custom_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_debug_shape_custom_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_debug_shape_custom_color**\ (\ ) Пользовательский цвет для рисования фигуры в редакторе и во время выполнения, если **Видимые формы столкновения** включены в меню **Отладка**. Этот цвет будет выделен во время выполнения, если **ShapeCast3D** сталкивается с чем-то. Если установлено значение ``Цвет(0.0, 0.0, 0.0)`` (по умолчанию), используется цвет, заданный в :ref:`ProjectSettings.debug/shapes/collision/shape_color`. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_property_enabled: .. rst-class:: classref-property :ref:`bool` **enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_enabled**\ (\ ) Если ``true``, будут сообщаться столкновения. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_property_exclude_parent: .. rst-class:: classref-property :ref:`bool` **exclude_parent** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_exclude_parent_body**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_exclude_parent_body**\ (\ ) Если ``true``, родительский узел будет исключен из обнаружения столкновений. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_property_margin: .. rst-class:: classref-property :ref:`float` **margin** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_margin**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_margin**\ (\ ) Запас на столкновение для формы. Больший запас помогает обнаруживать столкновения более последовательно, за счет точности. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_property_max_results: .. rst-class:: classref-property :ref:`int` **max_results** = ``32`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_max_results**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_max_results**\ (\ ) С помощью этого параметра можно ограничить количество пересечений, чтобы сократить время обработки. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_property_shape: .. rst-class:: classref-property :ref:`Shape3D` **shape** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_shape**\ (\ value\: :ref:`Shape3D`\ ) - :ref:`Shape3D` **get_shape**\ (\ ) Форма, которая будет использоваться для запросов на столкновение. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_property_target_position: .. rst-class:: classref-property :ref:`Vector3` **target_position** = ``Vector3(0, -1, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_target_position**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_target_position**\ (\ ) Точка назначения фигуры относительно :ref:`Node3D.position` этого узла. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Описания метода ------------------------------ .. _class_ShapeCast3D_method_add_exception: .. rst-class:: classref-method |void| **add_exception**\ (\ node\: :ref:`CollisionObject3D`\ ) :ref:`🔗` Добавляет исключение столкновений, чтобы фигура не сообщала о столкновениях с указанным узлом. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_method_add_exception_rid: .. rst-class:: classref-method |void| **add_exception_rid**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Добавляет исключение столкновений, чтобы фигура не сообщала о столкновениях с указанным :ref:`RID`. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_method_clear_exceptions: .. rst-class:: classref-method |void| **clear_exceptions**\ (\ ) :ref:`🔗` Удаляет все исключения столкновений для этой фигуры. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_method_force_shapecast_update: .. rst-class:: classref-method |void| **force_shapecast_update**\ (\ ) :ref:`🔗` Обновляет информацию о столкновении для фигуры немедленно, не дожидаясь следующего вызова ``_physics_process``. Используйте этот метод, например, когда фигура или ее родительский элемент изменили состояние. \ **Примечание:** Установка :ref:`enabled` на ``true`` не требуется для работы этого. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_method_get_closest_collision_safe_fraction: .. rst-class:: classref-method :ref:`float` **get_closest_collision_safe_fraction**\ (\ ) |const| :ref:`🔗` Возвращает долю от начала этого приведения до его :ref:`target_position` того, насколько далеко может переместиться фигура, не вызывая столкновения, в виде значения между ``0.0`` и ``1.0``. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_method_get_closest_collision_unsafe_fraction: .. rst-class:: classref-method :ref:`float` **get_closest_collision_unsafe_fraction**\ (\ ) |const| :ref:`🔗` Возвращает долю от начала этого приведения до его :ref:`target_position` того, как далеко должна переместиться фигура, чтобы вызвать столкновение, как значение между ``0.0`` и ``1.0``. В идеальных условиях это было бы то же самое, что и :ref:`get_closest_collision_safe_fraction()`, однако приведение фигуры вычисляется дискретными шагами, поэтому точная точка столкновения может находиться между двумя вычисленными позициями. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_method_get_collider: .. rst-class:: classref-method :ref:`Object` **get_collider**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Возвращает столкнувшийся :ref:`Object` одного из нескольких столкновений в ``index`` или ``null``, если ни один объект не пересекает фигуру (т. е. :ref:`is_colliding()` возвращает ``false``). .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_method_get_collider_rid: .. rst-class:: classref-method :ref:`RID` **get_collider_rid**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Возвращает :ref:`RID` столкнувшегося объекта одного из нескольких столкновений в ``index``. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_method_get_collider_shape: .. rst-class:: classref-method :ref:`int` **get_collider_shape**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Возвращает идентификатор сталкивающейся фигуры одного из нескольких столкновений в ``index`` или ``0``, если ни один объект не пересекает фигуру (т.е. :ref:`is_colliding()` возвращает ``false``). .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_method_get_collision_count: .. rst-class:: classref-method :ref:`int` **get_collision_count**\ (\ ) |const| :ref:`🔗` Количество столкновений, обнаруженных в точке удара. Используйте это для итерации по нескольким столкновениям, как предусмотрено методами :ref:`get_collider()`, :ref:`get_collider_shape()`, :ref:`get_collision_point()` и :ref:`get_collision_normal()`. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_method_get_collision_mask_value: .. rst-class:: classref-method :ref:`bool` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Возвращает, включен ли указанный слой :ref:`collision_mask`, учитывая ``layer_number`` от 1 до 32. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_method_get_collision_normal: .. rst-class:: classref-method :ref:`Vector3` **get_collision_normal**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Возвращает нормаль одного из нескольких столкновений в точке ``index`` пересекающегося объекта. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_method_get_collision_point: .. rst-class:: classref-method :ref:`Vector3` **get_collision_point**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Возвращает точку столкновения одного из нескольких столкновений в ``index``, где фигура пересекает сталкивающийся объект. \ **Примечание:** Эта точка находится в **глобальной** системе координат. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_method_is_colliding: .. rst-class:: classref-method :ref:`bool` **is_colliding**\ (\ ) |const| :ref:`🔗` Возвращает, пересекается ли какой-либо объект с вектором фигуры (с учетом длины вектора). .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_method_remove_exception: .. rst-class:: classref-method |void| **remove_exception**\ (\ node\: :ref:`CollisionObject3D`\ ) :ref:`🔗` Удаляет исключение столкновения, чтобы фигура не сообщала о столкновениях с указанным узлом. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_method_remove_exception_rid: .. rst-class:: classref-method |void| **remove_exception_rid**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` Удаляет исключение столкновения, чтобы фигура не сообщала о столкновениях с указанным :ref:`RID`. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_method_resource_changed: .. rst-class:: classref-method |void| **resource_changed**\ (\ resource\: :ref:`Resource`\ ) :ref:`🔗` **Устарело:** Use :ref:`Resource.changed` instead. Этот метод ничего не даёт. .. rst-class:: classref-item-separator ---- .. _class_ShapeCast3D_method_set_collision_mask_value: .. rst-class:: classref-method |void| **set_collision_mask_value**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` На основе ``value`` включает или отключает указанный слой в :ref:`collision_mask` при заданном ``layer_number`` от 1 до 32. .. |virtual| replace:: :abbr:`virtual (Этот метод обычно должен быть переопределен пользователем, чтобы иметь какой-либо эффект.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (Этот метод не имеет побочных эффектов. Он не изменяет ни одну из переменных-членов экземпляра.)` .. |vararg| replace:: :abbr:`vararg (Этот метод принимает любое количество аргументов после описанных здесь.)` .. |constructor| replace:: :abbr:`constructor (Этот метод используется для создания типа.)` .. |static| replace:: :abbr:`static (Этот метод не нуждается в вызове экземпляра, поэтому его можно вызвать напрямую, используя имя класса.)` .. |operator| replace:: :abbr:`operator (Этот метод описывает допустимый оператор для использования с этим типом в качестве левого операнда.)` .. |bitfield| replace:: :abbr:`BitField (Это значение является целым числом, составленным как битовая маска следующих флагов.)` .. |void| replace:: :abbr:`void (Нет возвращаемого значения.)`