class_interpolatedcamera.rst 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the InterpolatedCamera.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_InterpolatedCamera:
  5. InterpolatedCamera
  6. ==================
  7. **Inherits:** :ref:`Camera<class_Camera>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Camera which moves toward another node.
  12. Properties
  13. ----------
  14. +---------------------------------+-----------------------------------------------------------+
  15. | :ref:`bool<class_bool>` | :ref:`enabled<class_InterpolatedCamera_property_enabled>` |
  16. +---------------------------------+-----------------------------------------------------------+
  17. | :ref:`float<class_float>` | :ref:`speed<class_InterpolatedCamera_property_speed>` |
  18. +---------------------------------+-----------------------------------------------------------+
  19. | :ref:`NodePath<class_NodePath>` | :ref:`target<class_InterpolatedCamera_property_target>` |
  20. +---------------------------------+-----------------------------------------------------------+
  21. Methods
  22. -------
  23. +------+--------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`set_target<class_InterpolatedCamera_method_set_target>` **(** :ref:`Object<class_Object>` target **)** |
  25. +------+--------------------------------------------------------------------------------------------------------------+
  26. Description
  27. -----------
  28. InterpolatedCamera is a :ref:`Camera<class_Camera>` which smoothly moves to match a target node's position and rotation.
  29. If it is not :ref:`enabled<class_InterpolatedCamera_property_enabled>` or does not have a valid target set, InterpolatedCamera acts like a normal Camera.
  30. Property Descriptions
  31. ---------------------
  32. .. _class_InterpolatedCamera_property_enabled:
  33. - :ref:`bool<class_bool>` **enabled**
  34. +----------+----------------------------------+
  35. | *Setter* | set_interpolation_enabled(value) |
  36. +----------+----------------------------------+
  37. | *Getter* | is_interpolation_enabled() |
  38. +----------+----------------------------------+
  39. If ``true``, and a target is set, the camera will move automatically.
  40. .. _class_InterpolatedCamera_property_speed:
  41. - :ref:`float<class_float>` **speed**
  42. +----------+------------------+
  43. | *Setter* | set_speed(value) |
  44. +----------+------------------+
  45. | *Getter* | get_speed() |
  46. +----------+------------------+
  47. How quickly the camera moves toward its target. Higher values will result in tighter camera motion.
  48. .. _class_InterpolatedCamera_property_target:
  49. - :ref:`NodePath<class_NodePath>` **target**
  50. +----------+------------------------+
  51. | *Setter* | set_target_path(value) |
  52. +----------+------------------------+
  53. | *Getter* | get_target_path() |
  54. +----------+------------------------+
  55. The target's :ref:`NodePath<class_NodePath>`.
  56. Method Descriptions
  57. -------------------
  58. .. _class_InterpolatedCamera_method_set_target:
  59. - void **set_target** **(** :ref:`Object<class_Object>` target **)**
  60. Sets the node to move toward and orient with.