: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/CollisionObject2D.xml. .. _class_CollisionObject2D: CollisionObject2D ================= **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`Area2D`, :ref:`PhysicsBody2D` Base node for 2D collision objects. .. rst-class:: classref-introduction-group Description ----------- CollisionObject2D is the base class for 2D physics objects. It can hold any number of 2D collision :ref:`Shape2D`\ s. Each shape must be assigned to a *shape owner*. The CollisionObject2D can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the ``shape_owner_*`` methods. \ **Note:** Only collisions between objects within the same canvas (:ref:`Viewport` canvas or :ref:`CanvasLayer`) are supported. The behavior of collisions between objects in different canvases is undefined. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------+--------------------------------------------------------------------------+----------+ | :ref:`int` | :ref:`collision_layer` | ``1`` | +-------------------------+--------------------------------------------------------------------------+----------+ | :ref:`int` | :ref:`collision_mask` | ``1`` | +-------------------------+--------------------------------------------------------------------------+----------+ | :ref:`bool` | :ref:`input_pickable` | ``true`` | +-------------------------+--------------------------------------------------------------------------+----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_input_event` **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** |virtual| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_shape_owner_one_way_collision_margin` **(** :ref:`int` owner_id **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_shape_owners` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_shape_owner_disabled` **(** :ref:`int` owner_id **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_shape_owner_one_way_collision_enabled` **(** :ref:`int` owner_id **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_shape_owner` **(** :ref:`int` owner_id **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Shape2D` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shape_owner_get_shape_index` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_set_disabled` **(** :ref:`int` owner_id, :ref:`bool` disabled **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_set_one_way_collision` **(** :ref:`int` owner_id, :ref:`bool` enable **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_set_one_way_collision_margin` **(** :ref:`int` owner_id, :ref:`float` margin **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_set_transform` **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_CollisionObject2D_signal_input_event: .. rst-class:: classref-signal **input_event** **(** :ref:`Node` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** Emitted when an input event occurs. Requires :ref:`input_pickable` to be ``true`` and at least one ``collision_layer`` bit to be set. See :ref:`_input_event` for details. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_signal_mouse_entered: .. rst-class:: classref-signal **mouse_entered** **(** **)** Emitted when the mouse pointer enters any of this object's shapes. Requires :ref:`input_pickable` to be ``true`` and at least one ``collision_layer`` bit to be set. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_signal_mouse_exited: .. rst-class:: classref-signal **mouse_exited** **(** **)** Emitted when the mouse pointer exits all this object's shapes. Requires :ref:`input_pickable` to be ``true`` and at least one ``collision_layer`` bit to be set. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_CollisionObject2D_property_collision_layer: .. rst-class:: classref-property :ref:`int` **collision_layer** = ``1`` .. rst-class:: classref-property-setget - void **set_collision_layer** **(** :ref:`int` value **)** - :ref:`int` **get_collision_layer** **(** **)** The physics layers this CollisionObject2D is in. Collision objects can exist in one or more of 32 different layers. See also :ref:`collision_mask`. \ **Note:** A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_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** **(** **)** The physics layers this CollisionObject2D scans. Collision objects can scan one or more of 32 different layers. See also :ref:`collision_layer`. \ **Note:** A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_property_input_pickable: .. rst-class:: classref-property :ref:`bool` **input_pickable** = ``true`` .. rst-class:: classref-property-setget - void **set_pickable** **(** :ref:`bool` value **)** - :ref:`bool` **is_pickable** **(** **)** If ``true``, this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events. Requires at least one :ref:`collision_layer` bit to be set. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_CollisionObject2D_method__input_event: .. rst-class:: classref-method void **_input_event** **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** |virtual| Accepts unhandled :ref:`InputEvent`\ s. Requires :ref:`input_pickable` to be ``true``. ``shape_idx`` is the child index of the clicked :ref:`Shape2D`. Connect to the ``input_event`` signal to easily pick up these events. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_create_shape_owner: .. rst-class:: classref-method :ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_get_collision_layer_bit: .. rst-class:: classref-method :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** |const| Returns whether or not the specified ``bit`` of the :ref:`collision_layer` is set. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_get_collision_mask_bit: .. rst-class:: classref-method :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** |const| Returns whether or not the specified ``bit`` of the :ref:`collision_mask` is set. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_get_rid: .. rst-class:: classref-method :ref:`RID` **get_rid** **(** **)** |const| Returns the object's :ref:`RID`. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_get_shape_owner_one_way_collision_margin: .. rst-class:: classref-method :ref:`float` **get_shape_owner_one_way_collision_margin** **(** :ref:`int` owner_id **)** |const| Returns the ``one_way_collision_margin`` of the shape owner identified by given ``owner_id``. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_get_shape_owners: .. rst-class:: classref-method :ref:`Array` **get_shape_owners** **(** **)** Returns an :ref:`Array` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_is_shape_owner_disabled: .. rst-class:: classref-method :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** |const| If ``true``, the shape owner and its shapes are disabled. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_is_shape_owner_one_way_collision_enabled: .. rst-class:: classref-method :ref:`bool` **is_shape_owner_one_way_collision_enabled** **(** :ref:`int` owner_id **)** |const| Returns ``true`` if collisions for the shape owner originating from this **CollisionObject2D** will not be reported to collided with **CollisionObject2D**\ s. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_remove_shape_owner: .. rst-class:: classref-method void **remove_shape_owner** **(** :ref:`int` owner_id **)** Removes the given shape owner. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_set_collision_layer_bit: .. rst-class:: classref-method void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** If ``value`` is ``true``, sets the specified ``bit`` in the :ref:`collision_layer`. If ``value`` is ``false``, clears the specified ``bit`` in the :ref:`collision_layer`. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_set_collision_mask_bit: .. rst-class:: classref-method void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** If ``value`` is ``true``, sets the specified ``bit`` in the :ref:`collision_mask`. If ``value`` is ``false``, clears the specified ``bit`` in the :ref:`collision_mask`. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_shape_find_owner: .. rst-class:: classref-method :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** |const| Returns the ``owner_id`` of the given shape. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_shape_owner_add_shape: .. rst-class:: classref-method void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape2D` shape **)** Adds a :ref:`Shape2D` to the shape owner. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_shape_owner_clear_shapes: .. rst-class:: classref-method void **shape_owner_clear_shapes** **(** :ref:`int` owner_id **)** Removes all shapes from the shape owner. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_shape_owner_get_owner: .. rst-class:: classref-method :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** |const| Returns the parent object of the given shape owner. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_shape_owner_get_shape: .. rst-class:: classref-method :ref:`Shape2D` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| Returns the :ref:`Shape2D` with the given id from the given shape owner. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_shape_owner_get_shape_count: .. rst-class:: classref-method :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** |const| Returns the number of shapes the given shape owner contains. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_shape_owner_get_shape_index: .. rst-class:: classref-method :ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** |const| Returns the child index of the :ref:`Shape2D` with the given id from the given shape owner. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_shape_owner_get_transform: .. rst-class:: classref-method :ref:`Transform2D` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** |const| Returns the shape owner's :ref:`Transform2D`. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_shape_owner_remove_shape: .. rst-class:: classref-method void **shape_owner_remove_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** Removes a shape from the given shape owner. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_shape_owner_set_disabled: .. rst-class:: classref-method void **shape_owner_set_disabled** **(** :ref:`int` owner_id, :ref:`bool` disabled **)** If ``true``, disables the given shape owner. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_shape_owner_set_one_way_collision: .. rst-class:: classref-method void **shape_owner_set_one_way_collision** **(** :ref:`int` owner_id, :ref:`bool` enable **)** If ``enable`` is ``true``, collisions for the shape owner originating from this **CollisionObject2D** will not be reported to collided with **CollisionObject2D**\ s. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_shape_owner_set_one_way_collision_margin: .. rst-class:: classref-method void **shape_owner_set_one_way_collision_margin** **(** :ref:`int` owner_id, :ref:`float` margin **)** Sets the ``one_way_collision_margin`` of the shape owner identified by given ``owner_id`` to ``margin`` pixels. .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_shape_owner_set_transform: .. rst-class:: classref-method void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform2D` transform **)** Sets the :ref:`Transform2D` of the given shape owner. .. |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.)`