.. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. .. _class_CollisionObject: CollisionObject =============== **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`PhysicsBody`, :ref:`Area` **Category:** Core Brief Description ----------------- Member Functions ---------------- +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_input_event` **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_pos, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_capture_input_on_drag` **(** **)** const | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_rid` **(** **)** const | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_shape_owners` **(** **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_ray_pickable` **(** **)** const | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_shape_owner_disabled` **(** :ref:`int` owner_id **)** const | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_shape_owner` **(** :ref:`int` owner_id **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_capture_input_on_drag` **(** :ref:`bool` enable **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ray_pickable` **(** :ref:`bool` ray_pickable **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shape_find_owner` **(** :ref:`int` shape_index **)** const | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_add_shape` **(** :ref:`int` owner_id, :ref:`Shape` shape **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`shape_owner_get_owner` **(** :ref:`int` owner_id **)** const | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Shape` | :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:`Transform` | :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_transform` **(** :ref:`int` owner_id, :ref:`Transform` transform **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **input_event** **(** :ref:`Object` camera, :ref:`Object` event, :ref:`Vector3` click_pos, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** - **mouse_entered** **(** **)** - **mouse_exited** **(** **)** Member Variables ---------------- - :ref:`bool` **input_capture_on_drag** - :ref:`bool` **input_ray_pickable** Member Function Description --------------------------- .. _class_CollisionObject__input_event: - void **_input_event** **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_pos, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual .. _class_CollisionObject_create_shape_owner: - :ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** Creates new holder for the shapes. Argument is a :ref:`CollisionShape` node. It will return owner_id which usually you will want to save for later use. .. _class_CollisionObject_get_capture_input_on_drag: - :ref:`bool` **get_capture_input_on_drag** **(** **)** const .. _class_CollisionObject_get_rid: - :ref:`RID` **get_rid** **(** **)** const .. _class_CollisionObject_get_shape_owners: - :ref:`Array` **get_shape_owners** **(** **)** Shape owner is a node which is holding concrete shape resources. This method will return an array which is holding an integer numbers that are representing unique ID of each owner. You can use those ids when you are using others shape_owner methods. .. _class_CollisionObject_is_ray_pickable: - :ref:`bool` **is_ray_pickable** **(** **)** const .. _class_CollisionObject_is_shape_owner_disabled: - :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const .. _class_CollisionObject_remove_shape_owner: - void **remove_shape_owner** **(** :ref:`int` owner_id **)** .. _class_CollisionObject_set_capture_input_on_drag: - void **set_capture_input_on_drag** **(** :ref:`bool` enable **)** .. _class_CollisionObject_set_ray_pickable: - void **set_ray_pickable** **(** :ref:`bool` ray_pickable **)** .. _class_CollisionObject_shape_find_owner: - :ref:`int` **shape_find_owner** **(** :ref:`int` shape_index **)** const .. _class_CollisionObject_shape_owner_add_shape: - void **shape_owner_add_shape** **(** :ref:`int` owner_id, :ref:`Shape` shape **)** .. _class_CollisionObject_shape_owner_clear_shapes: - void **shape_owner_clear_shapes** **(** :ref:`int` owner_id **)** Will remove all the shapes associated with given owner. .. _class_CollisionObject_shape_owner_get_owner: - :ref:`Object` **shape_owner_get_owner** **(** :ref:`int` owner_id **)** const .. _class_CollisionObject_shape_owner_get_shape: - :ref:`Shape` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const Will return a :ref:`Shape`. First argument owner_id is an integer that can be obtained from :ref:`get_shape_owners`. Shape_id is a position of the shape inside owner; it's a value in range from 0 to :ref:`shape_owner_get_shape_count`. .. _class_CollisionObject_shape_owner_get_shape_count: - :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** const Returns number of shapes to which given owner is associated to. .. _class_CollisionObject_shape_owner_get_shape_index: - :ref:`int` **shape_owner_get_shape_index** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** const .. _class_CollisionObject_shape_owner_get_transform: - :ref:`Transform` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** const Will return :ref:`Transform` of an owner node. .. _class_CollisionObject_shape_owner_remove_shape: - void **shape_owner_remove_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** Removes related shape from the owner. .. _class_CollisionObject_shape_owner_set_disabled: - void **shape_owner_set_disabled** **(** :ref:`int` owner_id, :ref:`bool` disabled **)** .. _class_CollisionObject_shape_owner_set_transform: - void **shape_owner_set_transform** **(** :ref:`int` owner_id, :ref:`Transform` transform **)**