181 lines
6.8 KiB
Text
181 lines
6.8 KiB
Text
|
:github_url: hide
|
||
|
|
|
||
|
|
.. DO NOT EDIT THIS FILE!!!
|
||
|
|
.. Generated automatically from Godot engine sources.
|
||
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
|
||
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InterpolatedCamera.xml.
|
||
|
|
|
||
|
|
.. _class_InterpolatedCamera:
|
||
|
|
|
||
|
|
InterpolatedCamera
|
||
|
|
==================
|
||
|
|
|
||
|
|
**Inherits:** :ref:`Camera<class_Camera>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
||
|
|
|
||
|
|
*Deprecated.* Camera which moves toward another node.
|
||
|
|
|
||
|
|
.. rst-class:: classref-introduction-group
|
||
|
|
|
||
|
|
Description
|
||
|
|
-----------
|
||
|
|
|
||
|
|
*Deprecated (will be removed in Godot 4.0).* 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.
|
||
|
|
|
||
|
|
.. rst-class:: classref-reftable-group
|
||
|
|
|
||
|
|
Properties
|
||
|
|
----------
|
||
|
|
|
||
|
|
.. table::
|
||
|
|
:widths: auto
|
||
|
|
|
||
|
|
+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
|
||
|
|
| :ref:`bool<class_bool>` | :ref:`enabled<class_InterpolatedCamera_property_enabled>` | ``false`` |
|
||
|
|
+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
|
||
|
|
| :ref:`InterpolatedCameraProcessMode<enum_InterpolatedCamera_InterpolatedCameraProcessMode>` | :ref:`process_mode<class_InterpolatedCamera_property_process_mode>` | ``1`` |
|
||
|
|
+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
|
||
|
|
| :ref:`float<class_float>` | :ref:`speed<class_InterpolatedCamera_property_speed>` | ``1.0`` |
|
||
|
|
+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
|
||
|
|
| :ref:`NodePath<class_NodePath>` | :ref:`target<class_InterpolatedCamera_property_target>` | ``NodePath("")`` |
|
||
|
|
+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
|
||
|
|
|
||
|
|
.. rst-class:: classref-reftable-group
|
||
|
|
|
||
|
|
Methods
|
||
|
|
-------
|
||
|
|
|
||
|
|
.. table::
|
||
|
|
:widths: auto
|
||
|
|
|
||
|
|
+------+--------------------------------------------------------------------------------------------------------------+
|
||
|
|
| void | :ref:`set_target<class_InterpolatedCamera_method_set_target>` **(** :ref:`Object<class_Object>` target **)** |
|
||
|
|
+------+--------------------------------------------------------------------------------------------------------------+
|
||
|
|
|
||
|
|
.. rst-class:: classref-section-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. rst-class:: classref-descriptions-group
|
||
|
|
|
||
|
|
Enumerations
|
||
|
|
------------
|
||
|
|
|
||
|
|
.. _enum_InterpolatedCamera_InterpolatedCameraProcessMode:
|
||
|
|
|
||
|
|
.. rst-class:: classref-enumeration
|
||
|
|
|
||
|
|
enum **InterpolatedCameraProcessMode**:
|
||
|
|
|
||
|
|
.. _class_InterpolatedCamera_constant_INTERPOLATED_CAMERA_PROCESS_PHYSICS:
|
||
|
|
|
||
|
|
.. rst-class:: classref-enumeration-constant
|
||
|
|
|
||
|
|
:ref:`InterpolatedCameraProcessMode<enum_InterpolatedCamera_InterpolatedCameraProcessMode>` **INTERPOLATED_CAMERA_PROCESS_PHYSICS** = ``0``
|
||
|
|
|
||
|
|
The camera updates with the ``_physics_process`` callback.
|
||
|
|
|
||
|
|
.. _class_InterpolatedCamera_constant_INTERPOLATED_CAMERA_PROCESS_IDLE:
|
||
|
|
|
||
|
|
.. rst-class:: classref-enumeration-constant
|
||
|
|
|
||
|
|
:ref:`InterpolatedCameraProcessMode<enum_InterpolatedCamera_InterpolatedCameraProcessMode>` **INTERPOLATED_CAMERA_PROCESS_IDLE** = ``1``
|
||
|
|
|
||
|
|
The camera updates with the ``_process`` callback.
|
||
|
|
|
||
|
|
.. rst-class:: classref-section-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. rst-class:: classref-descriptions-group
|
||
|
|
|
||
|
|
Property Descriptions
|
||
|
|
---------------------
|
||
|
|
|
||
|
|
.. _class_InterpolatedCamera_property_enabled:
|
||
|
|
|
||
|
|
.. rst-class:: classref-property
|
||
|
|
|
||
|
|
:ref:`bool<class_bool>` **enabled** = ``false``
|
||
|
|
|
||
|
|
.. rst-class:: classref-property-setget
|
||
|
|
|
||
|
|
- void **set_interpolation_enabled** **(** :ref:`bool<class_bool>` value **)**
|
||
|
|
- :ref:`bool<class_bool>` **is_interpolation_enabled** **(** **)**
|
||
|
|
|
||
|
|
If ``true``, and a target is set, the camera will move automatically.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_InterpolatedCamera_property_process_mode:
|
||
|
|
|
||
|
|
.. rst-class:: classref-property
|
||
|
|
|
||
|
|
:ref:`InterpolatedCameraProcessMode<enum_InterpolatedCamera_InterpolatedCameraProcessMode>` **process_mode** = ``1``
|
||
|
|
|
||
|
|
.. rst-class:: classref-property-setget
|
||
|
|
|
||
|
|
- void **set_process_mode** **(** :ref:`InterpolatedCameraProcessMode<enum_InterpolatedCamera_InterpolatedCameraProcessMode>` value **)**
|
||
|
|
- :ref:`InterpolatedCameraProcessMode<enum_InterpolatedCamera_InterpolatedCameraProcessMode>` **get_process_mode** **(** **)**
|
||
|
|
|
||
|
|
The camera's process callback. See :ref:`InterpolatedCameraProcessMode<enum_InterpolatedCamera_InterpolatedCameraProcessMode>`.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_InterpolatedCamera_property_speed:
|
||
|
|
|
||
|
|
.. rst-class:: classref-property
|
||
|
|
|
||
|
|
:ref:`float<class_float>` **speed** = ``1.0``
|
||
|
|
|
||
|
|
.. rst-class:: classref-property-setget
|
||
|
|
|
||
|
|
- void **set_speed** **(** :ref:`float<class_float>` value **)**
|
||
|
|
- :ref:`float<class_float>` **get_speed** **(** **)**
|
||
|
|
|
||
|
|
How quickly the camera moves toward its target. Higher values will result in tighter camera motion.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_InterpolatedCamera_property_target:
|
||
|
|
|
||
|
|
.. rst-class:: classref-property
|
||
|
|
|
||
|
|
:ref:`NodePath<class_NodePath>` **target** = ``NodePath("")``
|
||
|
|
|
||
|
|
.. rst-class:: classref-property-setget
|
||
|
|
|
||
|
|
- void **set_target_path** **(** :ref:`NodePath<class_NodePath>` value **)**
|
||
|
|
- :ref:`NodePath<class_NodePath>` **get_target_path** **(** **)**
|
||
|
|
|
||
|
|
The target's :ref:`NodePath<class_NodePath>`.
|
||
|
|
|
||
|
|
.. rst-class:: classref-section-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. rst-class:: classref-descriptions-group
|
||
|
|
|
||
|
|
Method Descriptions
|
||
|
|
-------------------
|
||
|
|
|
||
|
|
.. _class_InterpolatedCamera_method_set_target:
|
||
|
|
|
||
|
|
.. rst-class:: classref-method
|
||
|
|
|
||
|
|
void **set_target** **(** :ref:`Object<class_Object>` target **)**
|
||
|
|
|
||
|
|
Sets the node to move toward and orient with.
|
||
|
|
|
||
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
||
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
||
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
||
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|