diff options
Diffstat (limited to 'doc/classes/RemoteTransform2D.xml')
| -rw-r--r-- | doc/classes/RemoteTransform2D.xml | 86 |
1 files changed, 8 insertions, 78 deletions
diff --git a/doc/classes/RemoteTransform2D.xml b/doc/classes/RemoteTransform2D.xml index d6dcde5742..77308209ea 100644 --- a/doc/classes/RemoteTransform2D.xml +++ b/doc/classes/RemoteTransform2D.xml @@ -1,100 +1,30 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RemoteTransform2D" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="RemoteTransform2D" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> - RemoteTransform2D mirrors the [Transform2D] of another [CanvasItem] derived Node in the scene. + RemoteTransform2D leads 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. + RemoteTransform2D leads 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 scale. It can update using either global or local coordinates. </description> <tutorials> </tutorials> <demos> </demos> <methods> - <method name="get_remote_node" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - </description> - </method> - <method name="get_update_position" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_update_rotation" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_update_scale" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_use_global_coordinates" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_remote_node"> - <return type="void"> - </return> - <argument index="0" name="path" type="NodePath"> - </argument> - <description> - </description> - </method> - <method name="set_update_position"> - <return type="void"> - </return> - <argument index="0" name="update_remote_position" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_update_rotation"> - <return type="void"> - </return> - <argument index="0" name="update_remote_rotation" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_update_scale"> - <return type="void"> - </return> - <argument index="0" name="update_remote_scale" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_use_global_coordinates"> - <return type="void"> - </return> - <argument index="0" name="use_global_coordinates" type="bool"> - </argument> - <description> - </description> - </method> </methods> <members> <member name="remote_path" type="NodePath" setter="set_remote_node" getter="get_remote_node"> - The remote node's [NodePath]. + The [NodePath] to the remote node, relative to the RemoteTransform2D's position in the scene. </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. + If [code]true[/code] the remote node's position is tracked. Default value: [code]true[/code]. </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. + If [code]true[/code] the remote node's rotation is tracked. Default value: [code]true[/code]. </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. + If [code]true[/code] the remote node's scale is tracked. Default value: [code]true[/code]. </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]. |