virtualx-engine/doc/classes/EditorSelection.xml
Hugo Locurcio f7f6115f76
Proofread and improve the whole class reference
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
  and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
2019-06-27 22:30:19 +02:00

61 lines
1.5 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorSelection" inherits="Object" category="Core" version="3.2">
<brief_description>
Manages the SceneTree selection in the editor.
</brief_description>
<description>
This object manages the SceneTree selection in the editor.
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_node">
<return type="void">
</return>
<argument index="0" name="node" type="Node">
</argument>
<description>
Adds a node to the selection.
</description>
</method>
<method name="clear">
<return type="void">
</return>
<description>
Clear the selection.
</description>
</method>
<method name="get_selected_nodes">
<return type="Array">
</return>
<description>
Gets the list of selected nodes.
</description>
</method>
<method name="get_transformable_selected_nodes">
<return type="Array">
</return>
<description>
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.
</description>
</method>
<method name="remove_node">
<return type="void">
</return>
<argument index="0" name="node" type="Node">
</argument>
<description>
Removes a node from the selection.
</description>
</method>
</methods>
<signals>
<signal name="selection_changed">
<description>
Emitted when the selection changes.
</description>
</signal>
</signals>
<constants>
</constants>
</class>