diff options
| author | Chris Bradfield <cb@scribe.net> | 2017-10-22 17:29:57 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-22 17:29:57 -0700 |
| commit | 4bb02a1b68ddc7012e915af45761ee1134e08dd8 (patch) | |
| tree | 9c170c29a6c1a75047f9f66fd4194eefa8dc9ec9 /doc | |
| parent | d49f23fd1b4d4415c4738d54f3b5d4e57fd7360f (diff) | |
| parent | 0b7619fd9cca94f3b4551bac29ec7b8880e06b68 (diff) | |
Merge pull request #12318 from mhilbrunner/docs-remotetransform
[DOCS] RemoteTransform & RemoteTransform2D
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/RemoteTransform.xml | 8 | ||||
| -rw-r--r-- | doc/classes/RemoteTransform2D.xml | 8 |
2 files changed, 16 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> diff --git a/doc/classes/RemoteTransform2D.xml b/doc/classes/RemoteTransform2D.xml index 346b8de621..eac7427f9f 100644 --- a/doc/classes/RemoteTransform2D.xml +++ b/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> |