Files
godot-docs/classes/class_velocitytracker3d.rst
2021-11-15 12:28:38 +01:00

74 lines
3.5 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VelocityTracker3D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VelocityTracker3D:
VelocityTracker3D
=================
**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Properties
----------
+-------------------------+--------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`track_physics_step<class_VelocityTracker3D_property_track_physics_step>` | ``false`` |
+-------------------------+--------------------------------------------------------------------------------+-----------+
Methods
-------
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`get_tracked_linear_velocity<class_VelocityTracker3D_method_get_tracked_linear_velocity>` **(** **)** |const| |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`reset<class_VelocityTracker3D_method_reset>` **(** :ref:`Vector3<class_Vector3>` position **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update_position<class_VelocityTracker3D_method_update_position>` **(** :ref:`Vector3<class_Vector3>` position **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------+
Property Descriptions
---------------------
.. _class_VelocityTracker3D_property_track_physics_step:
- :ref:`bool<class_bool>` **track_physics_step**
+-----------+-------------------------------+
| *Default* | ``false`` |
+-----------+-------------------------------+
| *Setter* | set_track_physics_step(value) |
+-----------+-------------------------------+
| *Getter* | is_tracking_physics_step() |
+-----------+-------------------------------+
Method Descriptions
-------------------
.. _class_VelocityTracker3D_method_get_tracked_linear_velocity:
- :ref:`Vector3<class_Vector3>` **get_tracked_linear_velocity** **(** **)** |const|
----
.. _class_VelocityTracker3D_method_reset:
- void **reset** **(** :ref:`Vector3<class_Vector3>` position **)**
----
.. _class_VelocityTracker3D_method_update_position:
- void **update_position** **(** :ref:`Vector3<class_Vector3>` position **)**
.. |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.)`