class_editorselection.rst 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  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. .. _class_EditorSelection_selection_changed:
  28. - **selection_changed** **(** **)**
  29. Emitted when the selection changes.
  30. Description
  31. -----------
  32. This object manages the SceneTree selection in the editor.
  33. Member Function Description
  34. ---------------------------
  35. .. _class_EditorSelection_add_node:
  36. - void **add_node** **(** :ref:`Node<class_node>` node **)**
  37. Add a node to the selection.
  38. .. _class_EditorSelection_clear:
  39. - void **clear** **(** **)**
  40. Clear the selection.
  41. .. _class_EditorSelection_get_selected_nodes:
  42. - :ref:`Array<class_array>` **get_selected_nodes** **(** **)**
  43. Get the list of selected nodes.
  44. .. _class_EditorSelection_get_transformable_selected_nodes:
  45. - :ref:`Array<class_array>` **get_transformable_selected_nodes** **(** **)**
  46. 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.
  47. .. _class_EditorSelection_remove_node:
  48. - void **remove_node** **(** :ref:`Node<class_node>` node **)**
  49. Remove a node from the selection.