169 lines
6.1 KiB
Text
169 lines
6.1 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/RemoteTransform.xml.
|
||
|
|
|
||
|
|
.. _class_RemoteTransform:
|
||
|
|
|
||
|
|
RemoteTransform
|
||
|
|
===============
|
||
|
|
|
||
|
|
**Inherits:** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
||
|
|
|
||
|
|
RemoteTransform pushes its own :ref:`Transform<class_Transform>` to another :ref:`Spatial<class_Spatial>` derived Node in the scene.
|
||
|
|
|
||
|
|
.. rst-class:: classref-introduction-group
|
||
|
|
|
||
|
|
Description
|
||
|
|
-----------
|
||
|
|
|
||
|
|
RemoteTransform pushes its own :ref:`Transform<class_Transform>` to another :ref:`Spatial<class_Spatial>` derived Node (called the remote node) in the scene.
|
||
|
|
|
||
|
|
It can be set to update another Node's position, rotation and/or scale. It can use either global or local coordinates.
|
||
|
|
|
||
|
|
.. rst-class:: classref-reftable-group
|
||
|
|
|
||
|
|
Properties
|
||
|
|
----------
|
||
|
|
|
||
|
|
.. table::
|
||
|
|
:widths: auto
|
||
|
|
|
||
|
|
+---------------------------------+--------------------------------------------------------------------------------------+------------------+
|
||
|
|
| :ref:`NodePath<class_NodePath>` | :ref:`remote_path<class_RemoteTransform_property_remote_path>` | ``NodePath("")`` |
|
||
|
|
+---------------------------------+--------------------------------------------------------------------------------------+------------------+
|
||
|
|
| :ref:`bool<class_bool>` | :ref:`update_position<class_RemoteTransform_property_update_position>` | ``true`` |
|
||
|
|
+---------------------------------+--------------------------------------------------------------------------------------+------------------+
|
||
|
|
| :ref:`bool<class_bool>` | :ref:`update_rotation<class_RemoteTransform_property_update_rotation>` | ``true`` |
|
||
|
|
+---------------------------------+--------------------------------------------------------------------------------------+------------------+
|
||
|
|
| :ref:`bool<class_bool>` | :ref:`update_scale<class_RemoteTransform_property_update_scale>` | ``true`` |
|
||
|
|
+---------------------------------+--------------------------------------------------------------------------------------+------------------+
|
||
|
|
| :ref:`bool<class_bool>` | :ref:`use_global_coordinates<class_RemoteTransform_property_use_global_coordinates>` | ``true`` |
|
||
|
|
+---------------------------------+--------------------------------------------------------------------------------------+------------------+
|
||
|
|
|
||
|
|
.. rst-class:: classref-reftable-group
|
||
|
|
|
||
|
|
Methods
|
||
|
|
-------
|
||
|
|
|
||
|
|
.. table::
|
||
|
|
:widths: auto
|
||
|
|
|
||
|
|
+------+----------------------------------------------------------------------------------------+
|
||
|
|
| void | :ref:`force_update_cache<class_RemoteTransform_method_force_update_cache>` **(** **)** |
|
||
|
|
+------+----------------------------------------------------------------------------------------+
|
||
|
|
|
||
|
|
.. rst-class:: classref-section-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. rst-class:: classref-descriptions-group
|
||
|
|
|
||
|
|
Property Descriptions
|
||
|
|
---------------------
|
||
|
|
|
||
|
|
.. _class_RemoteTransform_property_remote_path:
|
||
|
|
|
||
|
|
.. rst-class:: classref-property
|
||
|
|
|
||
|
|
:ref:`NodePath<class_NodePath>` **remote_path** = ``NodePath("")``
|
||
|
|
|
||
|
|
.. rst-class:: classref-property-setget
|
||
|
|
|
||
|
|
- void **set_remote_node** **(** :ref:`NodePath<class_NodePath>` value **)**
|
||
|
|
- :ref:`NodePath<class_NodePath>` **get_remote_node** **(** **)**
|
||
|
|
|
||
|
|
The :ref:`NodePath<class_NodePath>` to the remote node, relative to the RemoteTransform's position in the scene.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_RemoteTransform_property_update_position:
|
||
|
|
|
||
|
|
.. rst-class:: classref-property
|
||
|
|
|
||
|
|
:ref:`bool<class_bool>` **update_position** = ``true``
|
||
|
|
|
||
|
|
.. rst-class:: classref-property-setget
|
||
|
|
|
||
|
|
- void **set_update_position** **(** :ref:`bool<class_bool>` value **)**
|
||
|
|
- :ref:`bool<class_bool>` **get_update_position** **(** **)**
|
||
|
|
|
||
|
|
If ``true``, the remote node's position is updated.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_RemoteTransform_property_update_rotation:
|
||
|
|
|
||
|
|
.. rst-class:: classref-property
|
||
|
|
|
||
|
|
:ref:`bool<class_bool>` **update_rotation** = ``true``
|
||
|
|
|
||
|
|
.. rst-class:: classref-property-setget
|
||
|
|
|
||
|
|
- void **set_update_rotation** **(** :ref:`bool<class_bool>` value **)**
|
||
|
|
- :ref:`bool<class_bool>` **get_update_rotation** **(** **)**
|
||
|
|
|
||
|
|
If ``true``, the remote node's rotation is updated.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_RemoteTransform_property_update_scale:
|
||
|
|
|
||
|
|
.. rst-class:: classref-property
|
||
|
|
|
||
|
|
:ref:`bool<class_bool>` **update_scale** = ``true``
|
||
|
|
|
||
|
|
.. rst-class:: classref-property-setget
|
||
|
|
|
||
|
|
- void **set_update_scale** **(** :ref:`bool<class_bool>` value **)**
|
||
|
|
- :ref:`bool<class_bool>` **get_update_scale** **(** **)**
|
||
|
|
|
||
|
|
If ``true``, the remote node's scale is updated.
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_RemoteTransform_property_use_global_coordinates:
|
||
|
|
|
||
|
|
.. rst-class:: classref-property
|
||
|
|
|
||
|
|
:ref:`bool<class_bool>` **use_global_coordinates** = ``true``
|
||
|
|
|
||
|
|
.. rst-class:: classref-property-setget
|
||
|
|
|
||
|
|
- void **set_use_global_coordinates** **(** :ref:`bool<class_bool>` value **)**
|
||
|
|
- :ref:`bool<class_bool>` **get_use_global_coordinates** **(** **)**
|
||
|
|
|
||
|
|
If ``true``, global coordinates are used. If ``false``, local coordinates are used.
|
||
|
|
|
||
|
|
.. rst-class:: classref-section-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. rst-class:: classref-descriptions-group
|
||
|
|
|
||
|
|
Method Descriptions
|
||
|
|
-------------------
|
||
|
|
|
||
|
|
.. _class_RemoteTransform_method_force_update_cache:
|
||
|
|
|
||
|
|
.. rst-class:: classref-method
|
||
|
|
|
||
|
|
void **force_update_cache** **(** **)**
|
||
|
|
|
||
|
|
**RemoteTransform** caches the remote node. It may not notice if the remote node disappears; :ref:`force_update_cache<class_RemoteTransform_method_force_update_cache>` forces it to update the cache again.
|
||
|
|
|
||
|
|
.. |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.)`
|