| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266 |
- :github_url: hide
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the CollisionObject.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_CollisionObject:
- CollisionObject
- ===============
- **Inherits:** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- **Inherited By:** :ref:`Area<class_Area>`, :ref:`PhysicsBody<class_PhysicsBody>`
- **Category:** Core
- Brief Description
- -----------------
- Base node for collision objects.
- Properties
- ----------
- +-------------------------+------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`input_capture_on_drag<class_CollisionObject_property_input_capture_on_drag>` |
- +-------------------------+------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`input_ray_pickable<class_CollisionObject_property_input_ray_pickable>` |
- +-------------------------+------------------------------------------------------------------------------------+
- Methods
- -------
- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`_input_event<class_CollisionObject_method__input_event>` **(** :ref:`Object<class_Object>` camera, :ref:`InputEvent<class_InputEvent>` event, :ref:`Vector3<class_Vector3>` click_position, :ref:`Vector3<class_Vector3>` click_normal, :ref:`int<class_int>` shape_idx **)** virtual |
- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`create_shape_owner<class_CollisionObject_method_create_shape_owner>` **(** :ref:`Object<class_Object>` owner **)** |
- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`get_rid<class_CollisionObject_method_get_rid>` **(** **)** const |
- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>` | :ref:`get_shape_owners<class_CollisionObject_method_get_shape_owners>` **(** **)** |
- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_shape_owner_disabled<class_CollisionObject_method_is_shape_owner_disabled>` **(** :ref:`int<class_int>` owner_id **)** const |
- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`remove_shape_owner<class_CollisionObject_method_remove_shape_owner>` **(** :ref:`int<class_int>` owner_id **)** |
- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`shape_find_owner<class_CollisionObject_method_shape_find_owner>` **(** :ref:`int<class_int>` shape_index **)** const |
- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`shape_owner_add_shape<class_CollisionObject_method_shape_owner_add_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`Shape<class_Shape>` shape **)** |
- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`shape_owner_clear_shapes<class_CollisionObject_method_shape_owner_clear_shapes>` **(** :ref:`int<class_int>` owner_id **)** |
- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Object<class_Object>` | :ref:`shape_owner_get_owner<class_CollisionObject_method_shape_owner_get_owner>` **(** :ref:`int<class_int>` owner_id **)** const |
- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Shape<class_Shape>` | :ref:`shape_owner_get_shape<class_CollisionObject_method_shape_owner_get_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const |
- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`shape_owner_get_shape_count<class_CollisionObject_method_shape_owner_get_shape_count>` **(** :ref:`int<class_int>` owner_id **)** const |
- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`shape_owner_get_shape_index<class_CollisionObject_method_shape_owner_get_shape_index>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const |
- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Transform<class_Transform>` | :ref:`shape_owner_get_transform<class_CollisionObject_method_shape_owner_get_transform>` **(** :ref:`int<class_int>` owner_id **)** const |
- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`shape_owner_remove_shape<class_CollisionObject_method_shape_owner_remove_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** |
- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`shape_owner_set_disabled<class_CollisionObject_method_shape_owner_set_disabled>` **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)** |
- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`shape_owner_set_transform<class_CollisionObject_method_shape_owner_set_transform>` **(** :ref:`int<class_int>` owner_id, :ref:`Transform<class_Transform>` transform **)** |
- +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Signals
- -------
- .. _class_CollisionObject_signal_input_event:
- - **input_event** **(** :ref:`Node<class_Node>` camera, :ref:`InputEvent<class_InputEvent>` event, :ref:`Vector3<class_Vector3>` click_position, :ref:`Vector3<class_Vector3>` click_normal, :ref:`int<class_int>` shape_idx **)**
- Emitted when :ref:`_input_event<class_CollisionObject_method__input_event>` receives an event. See its description for details.
- ----
- .. _class_CollisionObject_signal_mouse_entered:
- - **mouse_entered** **(** **)**
- Emitted when the mouse pointer enters any of this object's shapes.
- ----
- .. _class_CollisionObject_signal_mouse_exited:
- - **mouse_exited** **(** **)**
- Emitted when the mouse pointer exits all this object's shapes.
- Description
- -----------
- CollisionObject is the base class for physics objects. It can hold any number of collision :ref:`Shape<class_Shape>`\ s. Each shape must be assigned to a *shape owner*. The CollisionObject 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.
- Property Descriptions
- ---------------------
- .. _class_CollisionObject_property_input_capture_on_drag:
- - :ref:`bool<class_bool>` **input_capture_on_drag**
- +----------+----------------------------------+
- | *Setter* | set_capture_input_on_drag(value) |
- +----------+----------------------------------+
- | *Getter* | get_capture_input_on_drag() |
- +----------+----------------------------------+
- If ``true``, the ``CollisionObject`` will continue to receive input events as the mouse is dragged across its shapes. Default value: ``false``.
- ----
- .. _class_CollisionObject_property_input_ray_pickable:
- - :ref:`bool<class_bool>` **input_ray_pickable**
- +----------+-------------------------+
- | *Setter* | set_ray_pickable(value) |
- +----------+-------------------------+
- | *Getter* | is_ray_pickable() |
- +----------+-------------------------+
- If ``true``, the :ref:`CollisionObject<class_CollisionObject>`'s shapes will respond to :ref:`RayCast<class_RayCast>`\ s. Default value: ``true``.
- Method Descriptions
- -------------------
- .. _class_CollisionObject_method__input_event:
- - void **_input_event** **(** :ref:`Object<class_Object>` camera, :ref:`InputEvent<class_InputEvent>` event, :ref:`Vector3<class_Vector3>` click_position, :ref:`Vector3<class_Vector3>` click_normal, :ref:`int<class_int>` shape_idx **)** virtual
- Accepts unhandled :ref:`InputEvent<class_InputEvent>`\ s. ``click_position`` is the clicked location in world space and ``click_normal`` is the normal vector extending from the clicked surface of the :ref:`Shape<class_Shape>` at ``shape_idx``. Connect to the ``input_event`` signal to easily pick up these events.
- ----
- .. _class_CollisionObject_method_create_shape_owner:
- - :ref:`int<class_int>` **create_shape_owner** **(** :ref:`Object<class_Object>` owner **)**
- Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference.
- ----
- .. _class_CollisionObject_method_get_rid:
- - :ref:`RID<class_RID>` **get_rid** **(** **)** const
- Returns the object's :ref:`RID<class_RID>`.
- ----
- .. _class_CollisionObject_method_get_shape_owners:
- - :ref:`Array<class_Array>` **get_shape_owners** **(** **)**
- Returns an :ref:`Array<class_Array>` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument.
- ----
- .. _class_CollisionObject_method_is_shape_owner_disabled:
- - :ref:`bool<class_bool>` **is_shape_owner_disabled** **(** :ref:`int<class_int>` owner_id **)** const
- If ``true``, the shape owner and its shapes are disabled.
- ----
- .. _class_CollisionObject_method_remove_shape_owner:
- - void **remove_shape_owner** **(** :ref:`int<class_int>` owner_id **)**
- Removes the given shape owner.
- ----
- .. _class_CollisionObject_method_shape_find_owner:
- - :ref:`int<class_int>` **shape_find_owner** **(** :ref:`int<class_int>` shape_index **)** const
- Returns the ``owner_id`` of the given shape.
- ----
- .. _class_CollisionObject_method_shape_owner_add_shape:
- - void **shape_owner_add_shape** **(** :ref:`int<class_int>` owner_id, :ref:`Shape<class_Shape>` shape **)**
- Adds a :ref:`Shape<class_Shape>` to the shape owner.
- ----
- .. _class_CollisionObject_method_shape_owner_clear_shapes:
- - void **shape_owner_clear_shapes** **(** :ref:`int<class_int>` owner_id **)**
- Removes all shapes from the shape owner.
- ----
- .. _class_CollisionObject_method_shape_owner_get_owner:
- - :ref:`Object<class_Object>` **shape_owner_get_owner** **(** :ref:`int<class_int>` owner_id **)** const
- Returns the parent object of the given shape owner.
- ----
- .. _class_CollisionObject_method_shape_owner_get_shape:
- - :ref:`Shape<class_Shape>` **shape_owner_get_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const
- Returns the :ref:`Shape<class_Shape>` with the given id from the given shape owner.
- ----
- .. _class_CollisionObject_method_shape_owner_get_shape_count:
- - :ref:`int<class_int>` **shape_owner_get_shape_count** **(** :ref:`int<class_int>` owner_id **)** const
- Returns the number of shapes the given shape owner contains.
- ----
- .. _class_CollisionObject_method_shape_owner_get_shape_index:
- - :ref:`int<class_int>` **shape_owner_get_shape_index** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const
- Returns the child index of the :ref:`Shape<class_Shape>` with the given id from the given shape owner.
- ----
- .. _class_CollisionObject_method_shape_owner_get_transform:
- - :ref:`Transform<class_Transform>` **shape_owner_get_transform** **(** :ref:`int<class_int>` owner_id **)** const
- Returns the shape owner's :ref:`Transform<class_Transform>`.
- ----
- .. _class_CollisionObject_method_shape_owner_remove_shape:
- - void **shape_owner_remove_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)**
- Removes a shape from the given shape owner.
- ----
- .. _class_CollisionObject_method_shape_owner_set_disabled:
- - void **shape_owner_set_disabled** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)**
- If ``true``, disables the given shape owner.
- ----
- .. _class_CollisionObject_method_shape_owner_set_transform:
- - void **shape_owner_set_transform** **(** :ref:`int<class_int>` owner_id, :ref:`Transform<class_Transform>` transform **)**
- Sets the :ref:`Transform<class_Transform>` of the given shape owner.
|
