Files
godot-docs/classes/class_editorselection.rst
2020-01-21 09:28:25 +01:00

91 lines
3.2 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.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>`
**Category:** Core
Brief Description
-----------------
Manages the SceneTree selection in the editor.
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.
Description
-----------
This object manages the SceneTree selection in the editor.
Method Descriptions
-------------------
.. _class_EditorSelection_method_add_node:
- void **add_node** **(** :ref:`Node<class_Node>` node **)**
Add a node to the selection.
----
.. _class_EditorSelection_method_clear:
- void **clear** **(** **)**
Clear the selection.
----
.. _class_EditorSelection_method_get_selected_nodes:
- :ref:`Array<class_Array>` **get_selected_nodes** **(** **)**
Get the list of selected nodes.
----
.. _class_EditorSelection_method_get_transformable_selected_nodes:
- :ref:`Array<class_Array>` **get_transformable_selected_nodes** **(** **)**
Get the list of selected nodes, optimized for transform operations (ie, moving them, rotating, etc). This list avoids situations where a node is selected and also chid/grandchild.
----
.. _class_EditorSelection_method_remove_node:
- void **remove_node** **(** :ref:`Node<class_Node>` node **)**
Remove a node from the selection.