asgardius/virtualx-engine-docs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine-docs/_sources/classes/class_shapecast2d.rst.txt

491 lines
23 KiB
Text
Raw Normal View History

docs
2024-10-23 18:41:33 +02:00
:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ShapeCast2D.xml.
.. _class_ShapeCast2D:
ShapeCast2D
===========
**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
Node for physics collision sweep and immediate overlap queries. Similar to the :ref:`RayCast2D<class_RayCast2D>` node.
.. rst-class:: classref-introduction-group
Description
-----------
Shape casting allows to detect collision objects by sweeping the :ref:`shape<class_ShapeCast2D_property_shape>` along the cast direction determined by :ref:`target_position<class_ShapeCast2D_property_target_position>` (useful for things like beam weapons).
Immediate collision overlaps can be done with the :ref:`target_position<class_ShapeCast2D_property_target_position>` set to ``Vector2(0, 0)`` and by calling :ref:`force_shapecast_update<class_ShapeCast2D_method_force_shapecast_update>` within the same **physics_frame**. This also helps to overcome some limitations of :ref:`Area2D<class_Area2D>` when used as a continuous detection area, often requiring waiting a couple of frames before collision information is available to :ref:`Area2D<class_Area2D>` nodes, and when using the signals creates unnecessary complexity.
The node can detect multiple collision objects, but it's usually used to detect the first collision.
\ **Note:** Shape casting is more computationally expensive compared to ray casting.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+-------------------------------+----------------------------------------------------------------------------+----------------------+
| :ref:`bool<class_bool>` | :ref:`collide_with_areas<class_ShapeCast2D_property_collide_with_areas>` | ``false`` |
+-------------------------------+----------------------------------------------------------------------------+----------------------+
| :ref:`bool<class_bool>` | :ref:`collide_with_bodies<class_ShapeCast2D_property_collide_with_bodies>` | ``true`` |
+-------------------------------+----------------------------------------------------------------------------+----------------------+
| :ref:`int<class_int>` | :ref:`collision_mask<class_ShapeCast2D_property_collision_mask>` | ``1`` |
+-------------------------------+----------------------------------------------------------------------------+----------------------+
| :ref:`Array<class_Array>` | :ref:`collision_result<class_ShapeCast2D_property_collision_result>` | |
+-------------------------------+----------------------------------------------------------------------------+----------------------+
| :ref:`bool<class_bool>` | :ref:`enabled<class_ShapeCast2D_property_enabled>` | ``true`` |
+-------------------------------+----------------------------------------------------------------------------+----------------------+
| :ref:`bool<class_bool>` | :ref:`exclude_parent<class_ShapeCast2D_property_exclude_parent>` | ``true`` |
+-------------------------------+----------------------------------------------------------------------------+----------------------+
| :ref:`float<class_float>` | :ref:`margin<class_ShapeCast2D_property_margin>` | ``0.0`` |
+-------------------------------+----------------------------------------------------------------------------+----------------------+
| :ref:`int<class_int>` | :ref:`max_results<class_ShapeCast2D_property_max_results>` | ``32`` |
+-------------------------------+----------------------------------------------------------------------------+----------------------+
| :ref:`Shape2D<class_Shape2D>` | :ref:`shape<class_ShapeCast2D_property_shape>` | |
+-------------------------------+----------------------------------------------------------------------------+----------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`target_position<class_ShapeCast2D_property_target_position>` | ``Vector2( 0, 50 )`` |
+-------------------------------+----------------------------------------------------------------------------+----------------------+
.. rst-class:: classref-reftable-group
Methods
-------
.. table::
:widths: auto
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_exception<class_ShapeCast2D_method_add_exception>` **(** :ref:`Object<class_Object>` node **)** |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_exception_rid<class_ShapeCast2D_method_add_exception_rid>` **(** :ref:`RID<class_RID>` rid **)** |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_exceptions<class_ShapeCast2D_method_clear_exceptions>` **(** **)** |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`force_shapecast_update<class_ShapeCast2D_method_force_shapecast_update>` **(** **)** |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_closest_collision_safe_fraction<class_ShapeCast2D_method_get_closest_collision_safe_fraction>` **(** **)** |const| |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_closest_collision_unsafe_fraction<class_ShapeCast2D_method_get_closest_collision_unsafe_fraction>` **(** **)** |const| |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_Object>` | :ref:`get_collider<class_ShapeCast2D_method_get_collider>` **(** :ref:`int<class_int>` index **)** |const| |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_RID>` | :ref:`get_collider_rid<class_ShapeCast2D_method_get_collider_rid>` **(** :ref:`int<class_int>` index **)** |const| |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collider_shape<class_ShapeCast2D_method_get_collider_shape>` **(** :ref:`int<class_int>` index **)** |const| |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collision_count<class_ShapeCast2D_method_get_collision_count>` **(** **)** |const| |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_value<class_ShapeCast2D_method_get_collision_mask_value>` **(** :ref:`int<class_int>` layer_number **)** |const| |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_collision_normal<class_ShapeCast2D_method_get_collision_normal>` **(** :ref:`int<class_int>` index **)** |const| |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_collision_point<class_ShapeCast2D_method_get_collision_point>` **(** :ref:`int<class_int>` index **)** |const| |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_colliding<class_ShapeCast2D_method_is_colliding>` **(** **)** |const| |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_exception<class_ShapeCast2D_method_remove_exception>` **(** :ref:`Object<class_Object>` node **)** |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_exception_rid<class_ShapeCast2D_method_remove_exception_rid>` **(** :ref:`RID<class_RID>` rid **)** |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_mask_value<class_ShapeCast2D_method_set_collision_mask_value>` **(** :ref:`int<class_int>` layer_number, :ref:`bool<class_bool>` value **)** |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_ShapeCast2D_property_collide_with_areas:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **collide_with_areas** = ``false``
.. rst-class:: classref-property-setget
- void **set_collide_with_areas** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_collide_with_areas_enabled** **(** **)**
If ``true``, collision with :ref:`Area2D<class_Area2D>`\ s will be reported.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_property_collide_with_bodies:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **collide_with_bodies** = ``true``
.. rst-class:: classref-property-setget
- void **set_collide_with_bodies** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_collide_with_bodies_enabled** **(** **)**
If ``true``, collision with :ref:`PhysicsBody2D<class_PhysicsBody2D>`\ s will be reported.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_property_collision_mask:
.. rst-class:: classref-property
:ref:`int<class_int>` **collision_mask** = ``1``
.. rst-class:: classref-property-setget
- void **set_collision_mask** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_collision_mask** **(** **)**
The shape's collision mask. Only objects in at least one collision layer enabled in the mask will be detected.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_property_collision_result:
.. rst-class:: classref-property
:ref:`Array<class_Array>` **collision_result**
Returns the complete collision information from the collision sweep. The data returned is the same as in the :ref:`Physics2DDirectSpaceState.get_rest_info<class_Physics2DDirectSpaceState_method_get_rest_info>` method.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_property_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **enabled** = ``true``
.. rst-class:: classref-property-setget
- void **set_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_enabled** **(** **)**
If ``true``, collisions will be reported.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_property_exclude_parent:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **exclude_parent** = ``true``
.. rst-class:: classref-property-setget
- void **set_exclude_parent_body** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **get_exclude_parent_body** **(** **)**
If ``true``, the parent node will be excluded from collision detection.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_property_margin:
.. rst-class:: classref-property
:ref:`float<class_float>` **margin** = ``0.0``
.. rst-class:: classref-property-setget
- void **set_margin** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_margin** **(** **)**
The collision margin for the shape. A larger margin helps detecting collisions more consistently, at the cost of precision.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_property_max_results:
.. rst-class:: classref-property
:ref:`int<class_int>` **max_results** = ``32``
.. rst-class:: classref-property-setget
- void **set_max_results** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_max_results** **(** **)**
The number of intersections can be limited with this parameter, to reduce the processing time.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_property_shape:
.. rst-class:: classref-property
:ref:`Shape2D<class_Shape2D>` **shape**
.. rst-class:: classref-property-setget
- void **set_shape** **(** :ref:`Shape2D<class_Shape2D>` value **)**
- :ref:`Shape2D<class_Shape2D>` **get_shape** **(** **)**
The :ref:`Shape2D<class_Shape2D>`-derived shape to be used for collision queries.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_property_target_position:
.. rst-class:: classref-property
:ref:`Vector2<class_Vector2>` **target_position** = ``Vector2( 0, 50 )``
.. rst-class:: classref-property-setget
- void **set_target_position** **(** :ref:`Vector2<class_Vector2>` value **)**
- :ref:`Vector2<class_Vector2>` **get_target_position** **(** **)**
The shape's destination point, relative to this node's ``position``.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Method Descriptions
-------------------
.. _class_ShapeCast2D_method_add_exception:
.. rst-class:: classref-method
void **add_exception** **(** :ref:`Object<class_Object>` node **)**
Adds a collision exception so the shape does not report collisions with the specified :ref:`CollisionObject2D<class_CollisionObject2D>` node.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_method_add_exception_rid:
.. rst-class:: classref-method
void **add_exception_rid** **(** :ref:`RID<class_RID>` rid **)**
Adds a collision exception so the shape does not report collisions with the specified :ref:`RID<class_RID>`.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_method_clear_exceptions:
.. rst-class:: classref-method
void **clear_exceptions** **(** **)**
Removes all collision exceptions for this shape.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_method_force_shapecast_update:
.. rst-class:: classref-method
void **force_shapecast_update** **(** **)**
Updates the collision information for the shape. Use this method to update the collision information immediately instead of waiting for the next ``_physics_process`` call, for example if the shape or its parent has changed state.
\ **Note:** ``enabled`` is not required for this to work.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_method_get_closest_collision_safe_fraction:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_closest_collision_safe_fraction** **(** **)** |const|
The fraction from the **ShapeCast2D**'s origin to its :ref:`target_position<class_ShapeCast2D_property_target_position>` (between 0 and 1) of how far the shape can move without triggering a collision.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_method_get_closest_collision_unsafe_fraction:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_closest_collision_unsafe_fraction** **(** **)** |const|
The fraction from the **ShapeCast2D**'s origin to its :ref:`target_position<class_ShapeCast2D_property_target_position>` (between 0 and 1) of how far the shape must move to trigger a collision.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_method_get_collider:
.. rst-class:: classref-method
:ref:`Object<class_Object>` **get_collider** **(** :ref:`int<class_int>` index **)** |const|
Returns the collided :ref:`Object<class_Object>` of one of the multiple collisions at ``index``, or ``null`` if no object is intersecting the shape (i.e. :ref:`is_colliding<class_ShapeCast2D_method_is_colliding>` returns ``false``).
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_method_get_collider_rid:
.. rst-class:: classref-method
:ref:`RID<class_RID>` **get_collider_rid** **(** :ref:`int<class_int>` index **)** |const|
Returns the :ref:`RID<class_RID>` of the collided object of one of the multiple collisions at ``index``.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_method_get_collider_shape:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_collider_shape** **(** :ref:`int<class_int>` index **)** |const|
Returns the shape ID of the colliding shape of one of the multiple collisions at ``index``, or ``0`` if no object is intersecting the shape (i.e. :ref:`is_colliding<class_ShapeCast2D_method_is_colliding>` returns ``false``).
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_method_get_collision_count:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_collision_count** **(** **)** |const|
The number of collisions detected at the point of impact. Use this to iterate over multiple collisions as provided by :ref:`get_collider<class_ShapeCast2D_method_get_collider>`, :ref:`get_collider_shape<class_ShapeCast2D_method_get_collider_shape>`, :ref:`get_collision_point<class_ShapeCast2D_method_get_collision_point>`, and :ref:`get_collision_normal<class_ShapeCast2D_method_get_collision_normal>` methods.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_method_get_collision_mask_value:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **get_collision_mask_value** **(** :ref:`int<class_int>` layer_number **)** |const|
Returns whether or not the specified layer of the :ref:`collision_mask<class_ShapeCast2D_property_collision_mask>` is enabled, given a ``layer_number`` between 1 and 32.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_method_get_collision_normal:
.. rst-class:: classref-method
:ref:`Vector2<class_Vector2>` **get_collision_normal** **(** :ref:`int<class_int>` index **)** |const|
Returns the normal of one of the multiple collisions at ``index`` of the intersecting object.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_method_get_collision_point:
.. rst-class:: classref-method
:ref:`Vector2<class_Vector2>` **get_collision_point** **(** :ref:`int<class_int>` index **)** |const|
Returns the collision point of one of the multiple collisions at ``index`` where the shape intersects the colliding object.
\ **Note:** this point is in the **global** coordinate system.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_method_is_colliding:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_colliding** **(** **)** |const|
Returns whether any object is intersecting with the shape's vector (considering the vector length).
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_method_remove_exception:
.. rst-class:: classref-method
void **remove_exception** **(** :ref:`Object<class_Object>` node **)**
Removes a collision exception so the shape does report collisions with the specified :ref:`CollisionObject2D<class_CollisionObject2D>` node.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_method_remove_exception_rid:
.. rst-class:: classref-method
void **remove_exception_rid** **(** :ref:`RID<class_RID>` rid **)**
Removes a collision exception so the shape does report collisions with the specified :ref:`RID<class_RID>`.
.. rst-class:: classref-item-separator
----
.. _class_ShapeCast2D_method_set_collision_mask_value:
.. rst-class:: classref-method
void **set_collision_mask_value** **(** :ref:`int<class_int>` layer_number, :ref:`bool<class_bool>` value **)**
Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask<class_ShapeCast2D_property_collision_mask>`, given a ``layer_number`` between 1 and 32.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
Reference in a new issue Copy permalink