: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` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` RemoteTransform2D pushes its own :ref:`Transform2D` to another :ref:`Node2D` derived node in the scene. .. rst-class:: classref-introduction-group Description ----------- RemoteTransform2D pushes its own :ref:`Transform2D` to another :ref:`Node2D` 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` | :ref:`remote_path` | ``NodePath("")`` | +---------------------------------+----------------------------------------------------------------------------------------+------------------+ | :ref:`bool` | :ref:`update_position` | ``true`` | +---------------------------------+----------------------------------------------------------------------------------------+------------------+ | :ref:`bool` | :ref:`update_rotation` | ``true`` | +---------------------------------+----------------------------------------------------------------------------------------+------------------+ | :ref:`bool` | :ref:`update_scale` | ``true`` | +---------------------------------+----------------------------------------------------------------------------------------+------------------+ | :ref:`bool` | :ref:`use_global_coordinates` | ``true`` | +---------------------------------+----------------------------------------------------------------------------------------+------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +--------+------------------------------------------------------------------------------------+ | |void| | :ref:`force_update_cache`\ (\ ) | +--------+------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_RemoteTransform2D_property_remote_path: .. rst-class:: classref-property :ref:`NodePath` **remote_path** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_remote_node**\ (\ value\: :ref:`NodePath`\ ) - :ref:`NodePath` **get_remote_node**\ (\ ) The :ref:`NodePath` to the remote node, relative to the RemoteTransform2D's position in the scene. .. rst-class:: classref-item-separator ---- .. _class_RemoteTransform2D_property_update_position: .. rst-class:: classref-property :ref:`bool` **update_position** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_update_position**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_update_position**\ (\ ) If ``true``, the remote node's position is updated. .. rst-class:: classref-item-separator ---- .. _class_RemoteTransform2D_property_update_rotation: .. rst-class:: classref-property :ref:`bool` **update_rotation** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_update_rotation**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_update_rotation**\ (\ ) If ``true``, the remote node's rotation is updated. .. rst-class:: classref-item-separator ---- .. _class_RemoteTransform2D_property_update_scale: .. rst-class:: classref-property :ref:`bool` **update_scale** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_update_scale**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_update_scale**\ (\ ) If ``true``, the remote node's scale is updated. .. rst-class:: classref-item-separator ---- .. _class_RemoteTransform2D_property_use_global_coordinates: .. rst-class:: classref-property :ref:`bool` **use_global_coordinates** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_use_global_coordinates**\ (\ value\: :ref:`bool`\ ) - :ref:`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_RemoteTransform2D_method_force_update_cache: .. rst-class:: classref-method |void| **force_update_cache**\ (\ ) :ref:`🔗` **RemoteTransform2D** caches the remote node. It may not notice if the remote node disappears; :ref:`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.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`