summaryrefslogtreecommitdiff
path: root/doc/classes/RemoteTransform.xml
blob: fe754deea5588707b164a436e6982177adffa638 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
<?xml version="1.0" encoding="UTF-8" ?>
<class name="RemoteTransform" inherits="Spatial" category="Core" version="3.0-alpha">
	<brief_description>
		RemoteTransform leads the [Transform] of another [Spatial] derived Node in the scene.
	</brief_description>
	<description>
		RemoteTransform leads 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. 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>
				Returns the [NodePath] to the remote node, relative to the RemoteTransform's position in the scene.
			</description>
		</method>
		<method name="get_update_position" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns if the RemoteTransform is tracking position.
			</description>
		</method>
		<method name="get_update_rotation" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns if the RemoteTransform is tracking rotation.
			</description>
		</method>
		<method name="get_update_scale" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns if the RemoteTransform2D is tracking scale.
			</description>
		</method>
		<method name="get_use_global_coordinates" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns if the RemoteTransform is tracking using global coordinates.
			</description>
		</method>
		<method name="set_remote_node">
			<return type="void">
			</return>
			<argument index="0" name="path" type="NodePath">
			</argument>
			<description>
				Sets the [NodePath] to the remote node, relative to the RemoteTransform's position in the node scene.
			</description>
		</method>
		<method name="set_update_position">
			<return type="void">
			</return>
			<argument index="0" name="update_remote_position" type="bool">
			</argument>
			<description>
				Sets whether or not the position will be tracked.
			</description>
		</method>
		<method name="set_update_rotation">
			<return type="void">
			</return>
			<argument index="0" name="update_remote_rotation" type="bool">
			</argument>
			<description>
				Sets whether or not the rotation will be tracked.
			</description>
		</method>
		<method name="set_update_scale">
			<return type="void">
			</return>
			<argument index="0" name="update_remote_scale" type="bool">
			</argument>
			<description>
				Sets whether or not the scale will be tracked.
			</description>
		</method>
		<method name="set_use_global_coordinates">
			<return type="void">
			</return>
			<argument index="0" name="use_global_coordinates" type="bool">
			</argument>
			<description>
				Set whether or not to use global coordinates for tracking.

				If [code]true[/code], RemoteTransform will track using global coordinates, while if it's
				[code]false[/code] it will track using local coordinates.
			</description>
		</method>
	</methods>
	<members>
		<member name="remote_path" type="NodePath" setter="set_remote_node" getter="get_remote_node">
			The [NodePath] to the remote node, relative to the RemoteTransform'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 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 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 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].
		</member>
	</members>
	<constants>
	</constants>
</class>