godot-docs/classes/class_physics2dtestmotionresult.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Physics2DTestMotionResult.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_Physics2DTestMotionResult:

Physics2DTestMotionResult
=========================

**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`



Properties
----------

+-------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`Object<class_Object>`   | :ref:`collider<class_Physics2DTestMotionResult_property_collider>`                                   |                     |
+-------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>`         | :ref:`collider_id<class_Physics2DTestMotionResult_property_collider_id>`                             | ``0``               |
+-------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`RID<class_RID>`         | :ref:`collider_rid<class_Physics2DTestMotionResult_property_collider_rid>`                           |                     |
+-------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>`         | :ref:`collider_shape<class_Physics2DTestMotionResult_property_collider_shape>`                       | ``0``               |
+-------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`collider_velocity<class_Physics2DTestMotionResult_property_collider_velocity>`                 | ``Vector2( 0, 0 )`` |
+-------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>`     | :ref:`collision_depth<class_Physics2DTestMotionResult_property_collision_depth>`                     | ``0.0``             |
+-------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`collision_normal<class_Physics2DTestMotionResult_property_collision_normal>`                   | ``Vector2( 0, 0 )`` |
+-------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`collision_point<class_Physics2DTestMotionResult_property_collision_point>`                     | ``Vector2( 0, 0 )`` |
+-------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>`     | :ref:`collision_safe_fraction<class_Physics2DTestMotionResult_property_collision_safe_fraction>`     | ``0.0``             |
+-------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`float<class_float>`     | :ref:`collision_unsafe_fraction<class_Physics2DTestMotionResult_property_collision_unsafe_fraction>` | ``0.0``             |
+-------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`motion<class_Physics2DTestMotionResult_property_motion>`                                       | ``Vector2( 0, 0 )`` |
+-------------------------------+------------------------------------------------------------------------------------------------------+---------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`motion_remainder<class_Physics2DTestMotionResult_property_motion_remainder>`                   | ``Vector2( 0, 0 )`` |
+-------------------------------+------------------------------------------------------------------------------------------------------+---------------------+

Property Descriptions
---------------------

.. _class_Physics2DTestMotionResult_property_collider:

- :ref:`Object<class_Object>` **collider**

+----------+----------------+
| *Getter* | get_collider() |
+----------+----------------+

----

.. _class_Physics2DTestMotionResult_property_collider_id:

- :ref:`int<class_int>` **collider_id**

+-----------+-------------------+
| *Default* | ``0``             |
+-----------+-------------------+
| *Getter*  | get_collider_id() |
+-----------+-------------------+

----

.. _class_Physics2DTestMotionResult_property_collider_rid:

- :ref:`RID<class_RID>` **collider_rid**

+----------+--------------------+
| *Getter* | get_collider_rid() |
+----------+--------------------+

----

.. _class_Physics2DTestMotionResult_property_collider_shape:

- :ref:`int<class_int>` **collider_shape**

+-----------+----------------------+
| *Default* | ``0``                |
+-----------+----------------------+
| *Getter*  | get_collider_shape() |
+-----------+----------------------+

----

.. _class_Physics2DTestMotionResult_property_collider_velocity:

- :ref:`Vector2<class_Vector2>` **collider_velocity**

+-----------+-------------------------+
| *Default* | ``Vector2( 0, 0 )``     |
+-----------+-------------------------+
| *Getter*  | get_collider_velocity() |
+-----------+-------------------------+

----

.. _class_Physics2DTestMotionResult_property_collision_depth:

- :ref:`float<class_float>` **collision_depth**

+-----------+-----------------------+
| *Default* | ``0.0``               |
+-----------+-----------------------+
| *Getter*  | get_collision_depth() |
+-----------+-----------------------+

----

.. _class_Physics2DTestMotionResult_property_collision_normal:

- :ref:`Vector2<class_Vector2>` **collision_normal**

+-----------+------------------------+
| *Default* | ``Vector2( 0, 0 )``    |
+-----------+------------------------+
| *Getter*  | get_collision_normal() |
+-----------+------------------------+

----

.. _class_Physics2DTestMotionResult_property_collision_point:

- :ref:`Vector2<class_Vector2>` **collision_point**

+-----------+-----------------------+
| *Default* | ``Vector2( 0, 0 )``   |
+-----------+-----------------------+
| *Getter*  | get_collision_point() |
+-----------+-----------------------+

----

.. _class_Physics2DTestMotionResult_property_collision_safe_fraction:

- :ref:`float<class_float>` **collision_safe_fraction**

+-----------+-------------------------------+
| *Default* | ``0.0``                       |
+-----------+-------------------------------+
| *Getter*  | get_collision_safe_fraction() |
+-----------+-------------------------------+

----

.. _class_Physics2DTestMotionResult_property_collision_unsafe_fraction:

- :ref:`float<class_float>` **collision_unsafe_fraction**

+-----------+---------------------------------+
| *Default* | ``0.0``                         |
+-----------+---------------------------------+
| *Getter*  | get_collision_unsafe_fraction() |
+-----------+---------------------------------+

----

.. _class_Physics2DTestMotionResult_property_motion:

- :ref:`Vector2<class_Vector2>` **motion**

+-----------+---------------------+
| *Default* | ``Vector2( 0, 0 )`` |
+-----------+---------------------+
| *Getter*  | get_motion()        |
+-----------+---------------------+

----

.. _class_Physics2DTestMotionResult_property_motion_remainder:

- :ref:`Vector2<class_Vector2>` **motion_remainder**

+-----------+------------------------+
| *Default* | ``Vector2( 0, 0 )``    |
+-----------+------------------------+
| *Getter*  | get_motion_remainder() |
+-----------+------------------------+

.. |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.)`