Browse Source

[DOCS] RemoteTransform & RemoteTransform2D

mhilbrunner 7 years ago
parent
commit
0b7619fd9c
2 changed files with 16 additions and 0 deletions
  1. 8 0
      doc/classes/RemoteTransform.xml
  2. 8 0
      doc/classes/RemoteTransform2D.xml

+ 8 - 0
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>

+ 8 - 0
doc/classes/RemoteTransform2D.xml

@@ -1,8 +1,11 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="RemoteTransform2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build">
 	<brief_description>
+		RemoteTransform2D mirrors the [Transform2D] of another [CanvasItem] derived Node in the scene.
 	</brief_description>
 	<description>
+		RemoteTransform2D mirrors the [Transform2D] of another [CanvasItem] derived Node (called the remote node) in the scene.
+		It can be set to track another Node's position, rotation and/or 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>