class_editorselection.rst 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the EditorSelection.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_EditorSelection:
  5. EditorSelection
  6. ===============
  7. **Inherits:** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Manages the SceneTree selection in the editor.
  12. Member Functions
  13. ----------------
  14. +----------------------------+--------------------------------------------------------------------------------------------------------------+
  15. | void | :ref:`add_node<class_EditorSelection_add_node>` **(** :ref:`Node<class_node>` node **)** |
  16. +----------------------------+--------------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`clear<class_EditorSelection_clear>` **(** **)** |
  18. +----------------------------+--------------------------------------------------------------------------------------------------------------+
  19. | :ref:`Array<class_array>` | :ref:`get_selected_nodes<class_EditorSelection_get_selected_nodes>` **(** **)** |
  20. +----------------------------+--------------------------------------------------------------------------------------------------------------+
  21. | :ref:`Array<class_array>` | :ref:`get_transformable_selected_nodes<class_EditorSelection_get_transformable_selected_nodes>` **(** **)** |
  22. +----------------------------+--------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`remove_node<class_EditorSelection_remove_node>` **(** :ref:`Node<class_node>` node **)** |
  24. +----------------------------+--------------------------------------------------------------------------------------------------------------+
  25. Signals
  26. -------
  27. - **selection_changed** **(** **)**
  28. Emitted when the selection changes.
  29. Description
  30. -----------
  31. This object manages the SceneTree selection in the editor.
  32. Member Function Description
  33. ---------------------------
  34. .. _class_EditorSelection_add_node:
  35. - void **add_node** **(** :ref:`Node<class_node>` node **)**
  36. Add a node to the selection.
  37. .. _class_EditorSelection_clear:
  38. - void **clear** **(** **)**
  39. Clear the selection.
  40. .. _class_EditorSelection_get_selected_nodes:
  41. - :ref:`Array<class_array>` **get_selected_nodes** **(** **)**
  42. Get the list of selectes nodes.
  43. .. _class_EditorSelection_get_transformable_selected_nodes:
  44. - :ref:`Array<class_array>` **get_transformable_selected_nodes** **(** **)**
  45. 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.
  46. .. _class_EditorSelection_remove_node:
  47. - void **remove_node** **(** :ref:`Node<class_node>` node **)**
  48. Remove a node from the selection.