class_interpolatedcamera.rst 3.2 KB

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