.. 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/CollisionObject2D.xml. .. _class_CollisionObject2D: CollisionObject2D ================= **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`Area2D`, :ref:`PhysicsBody2D` .. 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:`int` | :ref:`collision_layer` | ``1`` | +--------------------------------------------------------+--------------------------------------------------------------------------------+----------+ | :ref:`int` | :ref:`collision_mask` | ``1`` | +--------------------------------------------------------+--------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`collision_priority` | ``1.0`` | +--------------------------------------------------------+--------------------------------------------------------------------------------+----------+ | :ref:`DisableMode` | :ref:`disable_mode` | ``0`` | +--------------------------------------------------------+--------------------------------------------------------------------------------+----------+ | :ref:`bool` | :ref:`input_pickable` | ``true`` | +--------------------------------------------------------+--------------------------------------------------------------------------------+----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_input_event` **(** :ref:`Viewport` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** |virtual| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_mouse_enter` **(** **)** |virtual| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_mouse_exit` **(** **)** |virtual| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_mouse_shape_enter` **(** :ref:`int` shape_idx **)** |virtual| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_mouse_shape_exit` **(** :ref:`int` shape_idx **)** |virtual| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_layer_value` **(** :ref:`int` layer_number **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_value` **(** :ref:`int` layer_number **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_rid` **(** **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_shape_owner_one_way_collision_margin` **(** :ref:`int` owner_id **)** |const| | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :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_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_value` **(** :ref:`int` layer_number, :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 **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_signal_mouse_entered: .. rst-class:: classref-signal **mouse_entered** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_signal_mouse_exited: .. rst-class:: classref-signal **mouse_exited** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_signal_mouse_shape_entered: .. rst-class:: classref-signal **mouse_shape_entered** **(** :ref:`int` shape_idx **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_signal_mouse_shape_exited: .. rst-class:: classref-signal **mouse_shape_exited** **(** :ref:`int` shape_idx **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_CollisionObject2D_DisableMode: .. rst-class:: classref-enumeration enum **DisableMode**: .. _class_CollisionObject2D_constant_DISABLE_MODE_REMOVE: .. rst-class:: classref-enumeration-constant :ref:`DisableMode` **DISABLE_MODE_REMOVE** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_CollisionObject2D_constant_DISABLE_MODE_MAKE_STATIC: .. rst-class:: classref-enumeration-constant :ref:`DisableMode` **DISABLE_MODE_MAKE_STATIC** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_CollisionObject2D_constant_DISABLE_MODE_KEEP_ACTIVE: .. rst-class:: classref-enumeration-constant :ref:`DisableMode` **DISABLE_MODE_KEEP_ACTIVE** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. 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** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. 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** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_property_collision_priority: .. rst-class:: classref-property :ref:`float` **collision_priority** = ``1.0`` .. rst-class:: classref-property-setget - void **set_collision_priority** **(** :ref:`float` value **)** - :ref:`float` **get_collision_priority** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_property_disable_mode: .. rst-class:: classref-property :ref:`DisableMode` **disable_mode** = ``0`` .. rst-class:: classref-property-setget - void **set_disable_mode** **(** :ref:`DisableMode` value **)** - :ref:`DisableMode` **get_disable_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. 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** **(** **)** .. 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_CollisionObject2D_private_method__input_event: .. rst-class:: classref-method void **_input_event** **(** :ref:`Viewport` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_private_method__mouse_enter: .. rst-class:: classref-method void **_mouse_enter** **(** **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_private_method__mouse_exit: .. rst-class:: classref-method void **_mouse_exit** **(** **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_private_method__mouse_shape_enter: .. rst-class:: classref-method void **_mouse_shape_enter** **(** :ref:`int` shape_idx **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_private_method__mouse_shape_exit: .. rst-class:: classref-method void **_mouse_shape_exit** **(** :ref:`int` shape_idx **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_create_shape_owner: .. rst-class:: classref-method :ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_get_collision_layer_value: .. rst-class:: classref-method :ref:`bool` **get_collision_layer_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_CollisionObject2D_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_CollisionObject2D_method_get_rid: .. rst-class:: classref-method :ref:`RID` **get_rid** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_get_shape_owners: .. rst-class:: classref-method :ref:`PackedInt32Array` **get_shape_owners** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_remove_shape_owner: .. rst-class:: classref-method void **remove_shape_owner** **(** :ref:`int` owner_id **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_method_set_collision_layer_value: .. rst-class:: classref-method void **set_collision_layer_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 `! .. rst-class:: classref-item-separator ---- .. _class_CollisionObject2D_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 `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. 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 **)** .. 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.)`