class_editorselection.rst 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the EditorSelection.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_EditorSelection:
  6. EditorSelection
  7. ===============
  8. **Inherits:** :ref:`Object<class_Object>`
  9. Manages the SceneTree selection in the editor.
  10. Description
  11. -----------
  12. This object manages the SceneTree selection in the editor.
  13. **Note:** This class shouldn't be instantiated directly. Instead, access the singleton using :ref:`EditorInterface.get_selection<class_EditorInterface_method_get_selection>`.
  14. Methods
  15. -------
  16. +---------------------------+--------------------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`add_node<class_EditorSelection_method_add_node>` **(** :ref:`Node<class_Node>` node **)** |
  18. +---------------------------+--------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`clear<class_EditorSelection_method_clear>` **(** **)** |
  20. +---------------------------+--------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`Array<class_Array>` | :ref:`get_selected_nodes<class_EditorSelection_method_get_selected_nodes>` **(** **)** |
  22. +---------------------------+--------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`Array<class_Array>` | :ref:`get_transformable_selected_nodes<class_EditorSelection_method_get_transformable_selected_nodes>` **(** **)** |
  24. +---------------------------+--------------------------------------------------------------------------------------------------------------------+
  25. | void | :ref:`remove_node<class_EditorSelection_method_remove_node>` **(** :ref:`Node<class_Node>` node **)** |
  26. +---------------------------+--------------------------------------------------------------------------------------------------------------------+
  27. Signals
  28. -------
  29. .. _class_EditorSelection_signal_selection_changed:
  30. - **selection_changed** **(** **)**
  31. Emitted when the selection changes.
  32. Method Descriptions
  33. -------------------
  34. .. _class_EditorSelection_method_add_node:
  35. - void **add_node** **(** :ref:`Node<class_Node>` node **)**
  36. Adds a node to the selection.
  37. ----
  38. .. _class_EditorSelection_method_clear:
  39. - void **clear** **(** **)**
  40. Clear the selection.
  41. ----
  42. .. _class_EditorSelection_method_get_selected_nodes:
  43. - :ref:`Array<class_Array>` **get_selected_nodes** **(** **)**
  44. Gets the list of selected nodes.
  45. ----
  46. .. _class_EditorSelection_method_get_transformable_selected_nodes:
  47. - :ref:`Array<class_Array>` **get_transformable_selected_nodes** **(** **)**
  48. 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.
  49. ----
  50. .. _class_EditorSelection_method_remove_node:
  51. - void **remove_node** **(** :ref:`Node<class_Node>` node **)**
  52. Removes a node from the selection.
  53. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  54. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  55. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`