godot-docs/classes/class_remotetransform2d.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RemoteTransform2D.xml.

.. _class_RemoteTransform2D:

RemoteTransform2D
=================

**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

RemoteTransform2D pushes its own :ref:`Transform2D<class_Transform2D>` to another :ref:`CanvasItem<class_CanvasItem>` derived Node in the scene.

Description
-----------

RemoteTransform2D pushes its own :ref:`Transform2D<class_Transform2D>` to another :ref:`CanvasItem<class_CanvasItem>` 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.

Properties
----------

+---------------------------------+----------------------------------------------------------------------------------------+------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`remote_path<class_RemoteTransform2D_property_remote_path>`                       | ``NodePath("")`` |
+---------------------------------+----------------------------------------------------------------------------------------+------------------+
| :ref:`bool<class_bool>`         | :ref:`update_position<class_RemoteTransform2D_property_update_position>`               | ``true``         |
+---------------------------------+----------------------------------------------------------------------------------------+------------------+
| :ref:`bool<class_bool>`         | :ref:`update_rotation<class_RemoteTransform2D_property_update_rotation>`               | ``true``         |
+---------------------------------+----------------------------------------------------------------------------------------+------------------+
| :ref:`bool<class_bool>`         | :ref:`update_scale<class_RemoteTransform2D_property_update_scale>`                     | ``true``         |
+---------------------------------+----------------------------------------------------------------------------------------+------------------+
| :ref:`bool<class_bool>`         | :ref:`use_global_coordinates<class_RemoteTransform2D_property_use_global_coordinates>` | ``true``         |
+---------------------------------+----------------------------------------------------------------------------------------+------------------+

Methods
-------

+------+------------------------------------------------------------------------------------------+
| void | :ref:`force_update_cache<class_RemoteTransform2D_method_force_update_cache>` **(** **)** |
+------+------------------------------------------------------------------------------------------+

Property Descriptions
---------------------

.. _class_RemoteTransform2D_property_remote_path:

- :ref:`NodePath<class_NodePath>` **remote_path**

+-----------+------------------------+
| *Default* | ``NodePath("")``       |
+-----------+------------------------+
| *Setter*  | set_remote_node(value) |
+-----------+------------------------+
| *Getter*  | get_remote_node()      |
+-----------+------------------------+

The :ref:`NodePath<class_NodePath>` to the remote node, relative to the RemoteTransform2D's position in the scene.

----

.. _class_RemoteTransform2D_property_update_position:

- :ref:`bool<class_bool>` **update_position**

+-----------+----------------------------+
| *Default* | ``true``                   |
+-----------+----------------------------+
| *Setter*  | set_update_position(value) |
+-----------+----------------------------+
| *Getter*  | get_update_position()      |
+-----------+----------------------------+

If ``true``, the remote node's position is updated.

----

.. _class_RemoteTransform2D_property_update_rotation:

- :ref:`bool<class_bool>` **update_rotation**

+-----------+----------------------------+
| *Default* | ``true``                   |
+-----------+----------------------------+
| *Setter*  | set_update_rotation(value) |
+-----------+----------------------------+
| *Getter*  | get_update_rotation()      |
+-----------+----------------------------+

If ``true``, the remote node's rotation is updated.

----

.. _class_RemoteTransform2D_property_update_scale:

- :ref:`bool<class_bool>` **update_scale**

+-----------+-------------------------+
| *Default* | ``true``                |
+-----------+-------------------------+
| *Setter*  | set_update_scale(value) |
+-----------+-------------------------+
| *Getter*  | get_update_scale()      |
+-----------+-------------------------+

If ``true``, the remote node's scale is updated.

----

.. _class_RemoteTransform2D_property_use_global_coordinates:

- :ref:`bool<class_bool>` **use_global_coordinates**

+-----------+-----------------------------------+
| *Default* | ``true``                          |
+-----------+-----------------------------------+
| *Setter*  | set_use_global_coordinates(value) |
+-----------+-----------------------------------+
| *Getter*  | get_use_global_coordinates()      |
+-----------+-----------------------------------+

If ``true``, global coordinates are used. If ``false``, local coordinates are used.

Method Descriptions
-------------------

.. _class_RemoteTransform2D_method_force_update_cache:

- void **force_update_cache** **(** **)**

``RemoteTransform2D`` caches the remote node. It may not notice if the remote node disappears; :ref:`force_update_cache<class_RemoteTransform2D_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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`