.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/ShapeCast2D.xml. .. _class_ShapeCast2D: ShapeCast2D =========== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. 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:`bool` | :ref:`enabled` | ``true`` | +-------------------------------+----------------------------------------------------------------------------+--------------------+ | :ref:`bool` | :ref:`exclude_parent` | ``true`` | +-------------------------------+----------------------------------------------------------------------------+--------------------+ | :ref:`float` | :ref:`margin` | ``0.0`` | +-------------------------------+----------------------------------------------------------------------------+--------------------+ | :ref:`int` | :ref:`max_results` | ``32`` | +-------------------------------+----------------------------------------------------------------------------+--------------------+ | :ref:`Shape2D` | :ref:`shape` | | +-------------------------------+----------------------------------------------------------------------------+--------------------+ | :ref:`Vector2` | :ref:`target_position` | ``Vector2(0, 50)`` | +-------------------------------+----------------------------------------------------------------------------+--------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_exception` **(** :ref:`CollisionObject2D` node **)** | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_exception_rid` **(** :ref:`RID` 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` **(** :ref:`int` index **)** |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_collider_rid` **(** :ref:`int` index **)** |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collider_shape` **(** :ref:`int` index **)** |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collision_count` **(** **)** |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_value` **(** :ref:`int` layer_number **)** |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_collision_normal` **(** :ref:`int` index **)** |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_collision_point` **(** :ref:`int` index **)** |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_colliding` **(** **)** |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_exception` **(** :ref:`CollisionObject2D` node **)** | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_exception_rid` **(** :ref:`RID` rid **)** | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_value` **(** :ref:`int` layer_number, :ref:`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` **collide_with_areas** = ``false`` .. rst-class:: classref-property-setget - void **set_collide_with_areas** **(** :ref:`bool` value **)** - :ref:`bool` **is_collide_with_areas_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_property_collide_with_bodies: .. rst-class:: classref-property :ref:`bool` **collide_with_bodies** = ``true`` .. rst-class:: classref-property-setget - void **set_collide_with_bodies** **(** :ref:`bool` value **)** - :ref:`bool` **is_collide_with_bodies_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_property_collision_mask: .. rst-class:: classref-property :ref:`int` **collision_mask** = ``1`` .. rst-class:: classref-property-setget - void **set_collision_mask** **(** :ref:`int` value **)** - :ref:`int` **get_collision_mask** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_property_collision_result: .. rst-class:: classref-property :ref:`Array` **collision_result** = ``[]`` .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_property_enabled: .. rst-class:: classref-property :ref:`bool` **enabled** = ``true`` .. rst-class:: classref-property-setget - void **set_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_property_exclude_parent: .. rst-class:: classref-property :ref:`bool` **exclude_parent** = ``true`` .. rst-class:: classref-property-setget - void **set_exclude_parent_body** **(** :ref:`bool` value **)** - :ref:`bool` **get_exclude_parent_body** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_property_margin: .. rst-class:: classref-property :ref:`float` **margin** = ``0.0`` .. rst-class:: classref-property-setget - void **set_margin** **(** :ref:`float` value **)** - :ref:`float` **get_margin** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_property_max_results: .. rst-class:: classref-property :ref:`int` **max_results** = ``32`` .. rst-class:: classref-property-setget - void **set_max_results** **(** :ref:`int` value **)** - :ref:`int` **get_max_results** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_property_shape: .. rst-class:: classref-property :ref:`Shape2D` **shape** .. rst-class:: classref-property-setget - void **set_shape** **(** :ref:`Shape2D` value **)** - :ref:`Shape2D` **get_shape** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_property_target_position: .. rst-class:: classref-property :ref:`Vector2` **target_position** = ``Vector2(0, 50)`` .. rst-class:: classref-property-setget - void **set_target_position** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_target_position** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. 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:`CollisionObject2D` node **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_method_add_exception_rid: .. rst-class:: classref-method void **add_exception_rid** **(** :ref:`RID` rid **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_method_clear_exceptions: .. rst-class:: classref-method void **clear_exceptions** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_method_force_shapecast_update: .. rst-class:: classref-method void **force_shapecast_update** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_method_get_closest_collision_safe_fraction: .. rst-class:: classref-method :ref:`float` **get_closest_collision_safe_fraction** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_method_get_closest_collision_unsafe_fraction: .. rst-class:: classref-method :ref:`float` **get_closest_collision_unsafe_fraction** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_method_get_collider: .. rst-class:: classref-method :ref:`Object` **get_collider** **(** :ref:`int` index **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_method_get_collider_rid: .. rst-class:: classref-method :ref:`RID` **get_collider_rid** **(** :ref:`int` index **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_method_get_collider_shape: .. rst-class:: classref-method :ref:`int` **get_collider_shape** **(** :ref:`int` index **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_method_get_collision_count: .. rst-class:: classref-method :ref:`int` **get_collision_count** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_method_get_collision_mask_value: .. rst-class:: classref-method :ref:`bool` **get_collision_mask_value** **(** :ref:`int` layer_number **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_method_get_collision_normal: .. rst-class:: classref-method :ref:`Vector2` **get_collision_normal** **(** :ref:`int` index **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_method_get_collision_point: .. rst-class:: classref-method :ref:`Vector2` **get_collision_point** **(** :ref:`int` index **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_method_is_colliding: .. rst-class:: classref-method :ref:`bool` **is_colliding** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_method_remove_exception: .. rst-class:: classref-method void **remove_exception** **(** :ref:`CollisionObject2D` node **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_method_remove_exception_rid: .. rst-class:: classref-method void **remove_exception_rid** **(** :ref:`RID` rid **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ShapeCast2D_method_set_collision_mask_value: .. rst-class:: classref-method void **set_collision_mask_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`