| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the EditorSelection.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_EditorSelection:
- EditorSelection
- ===============
- **Inherits:** :ref:`Object<class_Object>`
- Manages the SceneTree selection in the editor.
- Description
- -----------
- This object manages the SceneTree selection in the editor.
- **Note:** This class shouldn't be instantiated directly. Instead, access the singleton using :ref:`EditorInterface.get_selection<class_EditorInterface_method_get_selection>`.
- Methods
- -------
- +---------------------------+--------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`add_node<class_EditorSelection_method_add_node>` **(** :ref:`Node<class_Node>` node **)** |
- +---------------------------+--------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`clear<class_EditorSelection_method_clear>` **(** **)** |
- +---------------------------+--------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>` | :ref:`get_selected_nodes<class_EditorSelection_method_get_selected_nodes>` **(** **)** |
- +---------------------------+--------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>` | :ref:`get_transformable_selected_nodes<class_EditorSelection_method_get_transformable_selected_nodes>` **(** **)** |
- +---------------------------+--------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`remove_node<class_EditorSelection_method_remove_node>` **(** :ref:`Node<class_Node>` node **)** |
- +---------------------------+--------------------------------------------------------------------------------------------------------------------+
- Signals
- -------
- .. _class_EditorSelection_signal_selection_changed:
- - **selection_changed** **(** **)**
- Emitted when the selection changes.
- Method Descriptions
- -------------------
- .. _class_EditorSelection_method_add_node:
- - void **add_node** **(** :ref:`Node<class_Node>` node **)**
- Adds a node to the selection.
- **Note:** The newly selected node will not be automatically edited in the inspector. If you want to edit a node, use :ref:`EditorInterface.edit_node<class_EditorInterface_method_edit_node>`.
- ----
- .. _class_EditorSelection_method_clear:
- - void **clear** **(** **)**
- Clear the selection.
- ----
- .. _class_EditorSelection_method_get_selected_nodes:
- - :ref:`Array<class_Array>` **get_selected_nodes** **(** **)**
- Gets the list of selected nodes.
- ----
- .. _class_EditorSelection_method_get_transformable_selected_nodes:
- - :ref:`Array<class_Array>` **get_transformable_selected_nodes** **(** **)**
- 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.
- ----
- .. _class_EditorSelection_method_remove_node:
- - void **remove_node** **(** :ref:`Node<class_Node>` node **)**
- Removes a node from the selection.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
