class_spatialvelocitytracker.rst 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  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. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Properties
  13. ----------
  14. +-------------------------+-------------------------------------------------------------------------------------+-------+
  15. | :ref:`bool<class_bool>` | :ref:`track_physics_step<class_SpatialVelocityTracker_property_track_physics_step>` | false |
  16. +-------------------------+-------------------------------------------------------------------------------------+-------+
  17. Methods
  18. -------
  19. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`Vector3<class_Vector3>` | :ref:`get_tracked_linear_velocity<class_SpatialVelocityTracker_method_get_tracked_linear_velocity>` **(** **)** const |
  21. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`reset<class_SpatialVelocityTracker_method_reset>` **(** :ref:`Vector3<class_Vector3>` position **)** |
  23. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`update_position<class_SpatialVelocityTracker_method_update_position>` **(** :ref:`Vector3<class_Vector3>` position **)** |
  25. +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  26. Property Descriptions
  27. ---------------------
  28. .. _class_SpatialVelocityTracker_property_track_physics_step:
  29. - :ref:`bool<class_bool>` **track_physics_step**
  30. +-----------+-------------------------------+
  31. | *Default* | false |
  32. +-----------+-------------------------------+
  33. | *Setter* | set_track_physics_step(value) |
  34. +-----------+-------------------------------+
  35. | *Getter* | is_tracking_physics_step() |
  36. +-----------+-------------------------------+
  37. Method Descriptions
  38. -------------------
  39. .. _class_SpatialVelocityTracker_method_get_tracked_linear_velocity:
  40. - :ref:`Vector3<class_Vector3>` **get_tracked_linear_velocity** **(** **)** const
  41. .. _class_SpatialVelocityTracker_method_reset:
  42. - void **reset** **(** :ref:`Vector3<class_Vector3>` position **)**
  43. .. _class_SpatialVelocityTracker_method_update_position:
  44. - void **update_position** **(** :ref:`Vector3<class_Vector3>` position **)**