summaryrefslogtreecommitdiff
path: root/doc/classes/RemoteTransform3D.xml
blob: ae2d0e3d881baf21ca7f0fe36ddfadae1c430cee (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="RemoteTransform3D" inherits="Node3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		RemoteTransform3D pushes its own [Transform3D] to another [Node3D] derived Node in the scene.
	</brief_description>
	<description>
		RemoteTransform3D pushes its own [Transform3D] to another [Node3D] derived Node (called the remote node) in the scene.
		It can be set to update another Node's position, rotation and/or scale. It can use either global or local coordinates.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="force_update_cache">
			<return type="void" />
			<description>
				[RemoteTransform3D] caches the remote node. It may not notice if the remote node disappears; [method force_update_cache] forces it to update the cache again.
			</description>
		</method>
	</methods>
	<members>
		<member name="remote_path" type="NodePath" setter="set_remote_node" getter="get_remote_node" default="NodePath(&quot;&quot;)">
			The [NodePath] to the remote node, relative to the RemoteTransform3D's position in the scene.
		</member>
		<member name="update_position" type="bool" setter="set_update_position" getter="get_update_position" default="true">
			If [code]true[/code], the remote node's position is updated.
		</member>
		<member name="update_rotation" type="bool" setter="set_update_rotation" getter="get_update_rotation" default="true">
			If [code]true[/code], the remote node's rotation is updated.
		</member>
		<member name="update_scale" type="bool" setter="set_update_scale" getter="get_update_scale" default="true">
			If [code]true[/code], the remote node's scale is updated.
		</member>
		<member name="use_global_coordinates" type="bool" setter="set_use_global_coordinates" getter="get_use_global_coordinates" default="true">
			If [code]true[/code], global coordinates are used. If [code]false[/code], local coordinates are used.
		</member>
	</members>
</class>