summaryrefslogtreecommitdiff
path: root/doc/classes/EditorSelection.xml
blob: 69ae865d5d53c03b3674e98c4b22719e6b0b9c9a (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorSelection" inherits="Object" version="4.0">
	<brief_description>
		Manages the SceneTree selection in the editor.
	</brief_description>
	<description>
		This object manages the SceneTree selection in the editor.
		[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_selection].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="add_node">
			<return type="void" />
			<argument index="0" name="node" type="Node" />
			<description>
				Adds a node to the selection.
				[b]Note:[/b] The newly selected node will not be automatically edited in the inspector. If you want to edit a node, use [method EditorInterface.edit_node].
			</description>
		</method>
		<method name="clear">
			<return type="void" />
			<description>
				Clear the selection.
			</description>
		</method>
		<method name="get_selected_nodes">
			<return type="Node[]" />
			<description>
				Gets the list of selected nodes.
			</description>
		</method>
		<method name="get_transformable_selected_nodes">
			<return type="Array" />
			<description>
				Gets the list of selected nodes, optimized for transform operations (i.e. moving them, rotating, etc). This list avoids situations where a node is selected and also child/grandchild.
			</description>
		</method>
		<method name="remove_node">
			<return type="void" />
			<argument index="0" name="node" type="Node" />
			<description>
				Removes a node from the selection.
			</description>
		</method>
	</methods>
	<signals>
		<signal name="selection_changed">
			<description>
				Emitted when the selection changes.
			</description>
		</signal>
	</signals>
	<constants>
	</constants>
</class>