class_interpolatedcamera.rst 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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. Member Functions
  13. ----------------
  14. +-------+-------------------------------------------------------------------------------------------------------+
  15. | void | :ref:`set_target<class_InterpolatedCamera_set_target>` **(** :ref:`Object<class_object>` target **)** |
  16. +-------+-------------------------------------------------------------------------------------------------------+
  17. Member Variables
  18. ----------------
  19. .. _class_InterpolatedCamera_enabled:
  20. - :ref:`bool<class_bool>` **enabled** - If ``true`` and a target is set, the camera will move automatically.
  21. .. _class_InterpolatedCamera_speed:
  22. - :ref:`float<class_float>` **speed** - How quickly the camera moves toward its target. Higher values will result in tighter camera motion.
  23. .. _class_InterpolatedCamera_target:
  24. - :ref:`NodePath<class_nodepath>` **target** - The target's :ref:`NodePath<class_nodepath>`.
  25. Description
  26. -----------
  27. InterpolatedCamera is a :ref:`Camera<class_camera>` which smoothly moves to match a target node's position and rotation.
  28. If it is not :ref:`enabled<class_InterpolatedCamera_enabled>` or does not have a valid target set, InterpolatedCamera acts like a normal Camera.
  29. Member Function Description
  30. ---------------------------
  31. .. _class_InterpolatedCamera_set_target:
  32. - void **set_target** **(** :ref:`Object<class_object>` target **)**
  33. Sets the node to move toward and orient with.