summaryrefslogtreecommitdiff
path: root/doc/classes/RemoteTransform.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/RemoteTransform.xml')
-rw-r--r--doc/classes/RemoteTransform.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/RemoteTransform.xml b/doc/classes/RemoteTransform.xml
index ecc136055e..67679bc9df 100644
--- a/doc/classes/RemoteTransform.xml
+++ b/doc/classes/RemoteTransform.xml
@@ -1,8 +1,11 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="RemoteTransform" inherits="Spatial" category="Core" version="3.0.alpha.custom_build">
<brief_description>
+ RemoteTransform mirrors the [Transform] of another [Spatial] derived Node in the scene.
</brief_description>
<description>
+ RemoteTransform mirrors the [Transform] of another [Spatial] derived Node (called the remote node) in the scene.
+ It can be set to track another Node's position, rotation and/or scale and update its own accordingly, using either global or local coordinates.
</description>
<tutorials>
</tutorials>
@@ -82,14 +85,19 @@
</methods>
<members>
<member name="remote_path" type="NodePath" setter="set_remote_node" getter="get_remote_node">
+ The remote node's [NodePath].
</member>
<member name="update_position" type="bool" setter="set_update_position" getter="get_update_position">
+ If [code]true[/code] the remote node's position is mirrored.
</member>
<member name="update_rotation" type="bool" setter="set_update_rotation" getter="get_update_rotation">
+ If [code]true[/code] the remote node's rotation is mirrored.
</member>
<member name="update_scale" type="bool" setter="set_update_scale" getter="get_update_scale">
+ If [code]true[/code] the remote node's scale is mirrored.
</member>
<member name="use_global_coordinates" type="bool" setter="set_use_global_coordinates" getter="get_use_global_coordinates">
+ If [code]true[/code] global coordinates are used. If [code]false[/code] local coordinates are used. Default value: [code]true[/code].
</member>
</members>
<constants>