1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798 |
- :github_url: hide
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the InterpolatedCamera.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_InterpolatedCamera:
- InterpolatedCamera
- ==================
- **Inherits:** :ref:`Camera<class_Camera>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- Camera which moves toward another node.
- Description
- -----------
- InterpolatedCamera is a :ref:`Camera<class_Camera>` which smoothly moves to match a target node's position and rotation.
- If it is not :ref:`enabled<class_InterpolatedCamera_property_enabled>` or does not have a valid target set, InterpolatedCamera acts like a normal Camera.
- Properties
- ----------
- +---------------------------------+-----------------------------------------------------------+------------------+
- | :ref:`bool<class_bool>` | :ref:`enabled<class_InterpolatedCamera_property_enabled>` | ``false`` |
- +---------------------------------+-----------------------------------------------------------+------------------+
- | :ref:`float<class_float>` | :ref:`speed<class_InterpolatedCamera_property_speed>` | ``1.0`` |
- +---------------------------------+-----------------------------------------------------------+------------------+
- | :ref:`NodePath<class_NodePath>` | :ref:`target<class_InterpolatedCamera_property_target>` | ``NodePath("")`` |
- +---------------------------------+-----------------------------------------------------------+------------------+
- Methods
- -------
- +------+--------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_target<class_InterpolatedCamera_method_set_target>` **(** :ref:`Object<class_Object>` target **)** |
- +------+--------------------------------------------------------------------------------------------------------------+
- Property Descriptions
- ---------------------
- .. _class_InterpolatedCamera_property_enabled:
- - :ref:`bool<class_bool>` **enabled**
- +-----------+----------------------------------+
- | *Default* | ``false`` |
- +-----------+----------------------------------+
- | *Setter* | set_interpolation_enabled(value) |
- +-----------+----------------------------------+
- | *Getter* | is_interpolation_enabled() |
- +-----------+----------------------------------+
- If ``true``, and a target is set, the camera will move automatically.
- ----
- .. _class_InterpolatedCamera_property_speed:
- - :ref:`float<class_float>` **speed**
- +-----------+------------------+
- | *Default* | ``1.0`` |
- +-----------+------------------+
- | *Setter* | set_speed(value) |
- +-----------+------------------+
- | *Getter* | get_speed() |
- +-----------+------------------+
- How quickly the camera moves toward its target. Higher values will result in tighter camera motion.
- ----
- .. _class_InterpolatedCamera_property_target:
- - :ref:`NodePath<class_NodePath>` **target**
- +-----------+------------------------+
- | *Default* | ``NodePath("")`` |
- +-----------+------------------------+
- | *Setter* | set_target_path(value) |
- +-----------+------------------------+
- | *Getter* | get_target_path() |
- +-----------+------------------------+
- The target's :ref:`NodePath<class_NodePath>`.
- Method Descriptions
- -------------------
- .. _class_InterpolatedCamera_method_set_target:
- - void **set_target** **(** :ref:`Object<class_Object>` target **)**
- Sets the node to move toward and orient with.
|