class_spatialvelocitytracker.rst 3.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the SpatialVelocityTracker.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_SpatialVelocityTracker:
  6. SpatialVelocityTracker
  7. ======================
  8. **Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Properties
  10. ----------
  11. +-------------------------+-------------------------------------------------------------------------------------+-----------+
  12. | :ref:`bool<class_bool>` | :ref:`track_physics_step<class_SpatialVelocityTracker_property_track_physics_step>` | ``false`` |
  13. +-------------------------+-------------------------------------------------------------------------------------+-----------+
  14. Methods
  15. -------
  16. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`Vector3<class_Vector3>` | :ref:`get_tracked_linear_velocity<class_SpatialVelocityTracker_method_get_tracked_linear_velocity>` **(** **)** |const| |
  18. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`reset<class_SpatialVelocityTracker_method_reset>` **(** :ref:`Vector3<class_Vector3>` position **)** |
  20. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`update_position<class_SpatialVelocityTracker_method_update_position>` **(** :ref:`Vector3<class_Vector3>` position **)** |
  22. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  23. Property Descriptions
  24. ---------------------
  25. .. _class_SpatialVelocityTracker_property_track_physics_step:
  26. - :ref:`bool<class_bool>` **track_physics_step**
  27. +-----------+-------------------------------+
  28. | *Default* | ``false`` |
  29. +-----------+-------------------------------+
  30. | *Setter* | set_track_physics_step(value) |
  31. +-----------+-------------------------------+
  32. | *Getter* | is_tracking_physics_step() |
  33. +-----------+-------------------------------+
  34. Method Descriptions
  35. -------------------
  36. .. _class_SpatialVelocityTracker_method_get_tracked_linear_velocity:
  37. - :ref:`Vector3<class_Vector3>` **get_tracked_linear_velocity** **(** **)** |const|
  38. ----
  39. .. _class_SpatialVelocityTracker_method_reset:
  40. - void **reset** **(** :ref:`Vector3<class_Vector3>` position **)**
  41. ----
  42. .. _class_SpatialVelocityTracker_method_update_position:
  43. - void **update_position** **(** :ref:`Vector3<class_Vector3>` position **)**
  44. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  45. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  46. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`