2017-09-12 17:42:36 -03:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 10:08:05 +02:00
<class name= "EditorSelection" inherits= "Object" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-12 17:42:36 -03:00
<brief_description >
Manages the SceneTree selection in the editor.
</brief_description>
<description >
This object manages the SceneTree selection in the editor.
2020-04-14 22:09:21 +02:00
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_selection].
2017-09-12 17:42:36 -03:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "add_node" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 21:11:48 +03:00
<param index= "0" name= "node" type= "Node" />
2017-09-12 17:42:36 -03:00
<description >
2019-06-22 01:04:47 +02:00
Adds a node to the selection.
2021-04-07 22:08:41 +02:00
[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].
2017-09-12 17:42:36 -03:00
</description>
</method>
<method name= "clear" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2017-09-12 17:42:36 -03:00
<description >
Clear the selection.
</description>
</method>
<method name= "get_selected_nodes" >
2021-07-30 15:28:05 +02:00
<return type= "Node[]" />
2017-09-12 17:42:36 -03:00
<description >
2024-03-01 00:59:28 +01:00
Returns the list of selected nodes.
2017-09-12 17:42:36 -03:00
</description>
</method>
2024-12-01 06:40:29 -08:00
<method name= "get_top_selected_nodes" >
2022-08-05 03:41:48 +02:00
<return type= "Node[]" />
2017-09-12 17:42:36 -03:00
<description >
2024-12-01 06:40:29 -08:00
Returns the list of top selected nodes only, excluding any children. This is useful for performing transform operations (moving them, rotating, etc.).
For example, if there is a node A with a child B and a sibling C, then selecting all three will cause this method to return only A and C. Changing the global transform of A will affect the global transform of B, so there is no need to change B separately.
</description>
</method>
<method name= "get_transformable_selected_nodes" deprecated= "Use [method get_top_selected_nodes] instead." >
<return type= "Node[]" />
<description >
Returns the list of top selected nodes only, excluding any children. This is useful for performing transform operations (moving them, rotating, etc.). See [method get_top_selected_nodes].
2017-09-12 17:42:36 -03:00
</description>
</method>
<method name= "remove_node" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 21:11:48 +03:00
<param index= "0" name= "node" type= "Node" />
2017-09-12 17:42:36 -03:00
<description >
2019-06-22 01:04:47 +02:00
Removes a node from the selection.
2017-09-12 17:42:36 -03:00
</description>
</method>
</methods>
<signals >
<signal name= "selection_changed" >
<description >
Emitted when the selection changes.
</description>
</signal>
</signals>
</class>