pandemonium_engine_docs/classes/class_spatialvelocitytracker.rst

71 lines
3.2 KiB
ReStructuredText
Raw Normal View History

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the SpatialVelocityTracker.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_SpatialVelocityTracker:
SpatialVelocityTracker
======================
**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Properties
----------
+-------------------------+-------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`track_physics_step<class_SpatialVelocityTracker_property_track_physics_step>` | ``false`` |
+-------------------------+-------------------------------------------------------------------------------------+-----------+
Methods
-------
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`get_tracked_linear_velocity<class_SpatialVelocityTracker_method_get_tracked_linear_velocity>` **(** **)** |const| |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`reset<class_SpatialVelocityTracker_method_reset>` **(** :ref:`Vector3<class_Vector3>` position **)** |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update_position<class_SpatialVelocityTracker_method_update_position>` **(** :ref:`Vector3<class_Vector3>` position **)** |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
Property Descriptions
---------------------
.. _class_SpatialVelocityTracker_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_SpatialVelocityTracker_method_get_tracked_linear_velocity:
- :ref:`Vector3<class_Vector3>` **get_tracked_linear_velocity** **(** **)** |const|
----
.. _class_SpatialVelocityTracker_method_reset:
- void **reset** **(** :ref:`Vector3<class_Vector3>` position **)**
----
.. _class_SpatialVelocityTracker_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.)`