mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
104 lines
4.3 KiB
ReStructuredText
104 lines
4.3 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the RemoteTransform2D.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_RemoteTransform2D:
|
|
|
|
RemoteTransform2D
|
|
=================
|
|
|
|
**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
RemoteTransform2D pushes its own :ref:`Transform2D<class_Transform2D>` to another :ref:`CanvasItem<class_CanvasItem>` derived Node in the scene.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------------+----------------------------------------------------------------------------------------+
|
|
| :ref:`NodePath<class_NodePath>` | :ref:`remote_path<class_RemoteTransform2D_property_remote_path>` |
|
|
+---------------------------------+----------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`update_position<class_RemoteTransform2D_property_update_position>` |
|
|
+---------------------------------+----------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`update_rotation<class_RemoteTransform2D_property_update_rotation>` |
|
|
+---------------------------------+----------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`update_scale<class_RemoteTransform2D_property_update_scale>` |
|
|
+---------------------------------+----------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`use_global_coordinates<class_RemoteTransform2D_property_use_global_coordinates>` |
|
|
+---------------------------------+----------------------------------------------------------------------------------------+
|
|
|
|
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.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_RemoteTransform2D_property_remote_path:
|
|
|
|
- :ref:`NodePath<class_NodePath>` **remote_path**
|
|
|
|
+----------+------------------------+
|
|
| *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**
|
|
|
|
+----------+----------------------------+
|
|
| *Setter* | set_update_position(value) |
|
|
+----------+----------------------------+
|
|
| *Getter* | get_update_position() |
|
|
+----------+----------------------------+
|
|
|
|
If ``true``, the remote node's position is updated. Default value: ``true``.
|
|
|
|
.. _class_RemoteTransform2D_property_update_rotation:
|
|
|
|
- :ref:`bool<class_bool>` **update_rotation**
|
|
|
|
+----------+----------------------------+
|
|
| *Setter* | set_update_rotation(value) |
|
|
+----------+----------------------------+
|
|
| *Getter* | get_update_rotation() |
|
|
+----------+----------------------------+
|
|
|
|
If ``true``, the remote node's rotation is updated. Default value: ``true``.
|
|
|
|
.. _class_RemoteTransform2D_property_update_scale:
|
|
|
|
- :ref:`bool<class_bool>` **update_scale**
|
|
|
|
+----------+-------------------------+
|
|
| *Setter* | set_update_scale(value) |
|
|
+----------+-------------------------+
|
|
| *Getter* | get_update_scale() |
|
|
+----------+-------------------------+
|
|
|
|
If ``true``, the remote node's scale is updated. Default value: ``true``.
|
|
|
|
.. _class_RemoteTransform2D_property_use_global_coordinates:
|
|
|
|
- :ref:`bool<class_bool>` **use_global_coordinates**
|
|
|
|
+----------+-----------------------------------+
|
|
| *Setter* | set_use_global_coordinates(value) |
|
|
+----------+-----------------------------------+
|
|
| *Getter* | get_use_global_coordinates() |
|
|
+----------+-----------------------------------+
|
|
|
|
If ``true``, global coordinates are used. If ``false``, local coordinates are used. Default value: ``true``.
|
|
|