:github_url: hide .. _class_ShapeCast3D: ShapeCast3D =========== **Успадковує:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` A 3D форма, яка спрощує область простору для виявлення :ref:`CollisionObject3D`\ s. .. 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:`PhysicsDirectSpaceState2D.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** з чимось стикається. Якщо встановлено значення ``Color(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:`🔗` Повертає форму ID комірцевої форми одного з декількох зіткнень за індексом ``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_layer`, враховуючи ``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 (Значення не повертається.)`