virtualx-engine/doc/classes/EditorInspector.xml
Rémi Verschelde ffe07d9332
Merge pull request #37888 from Calinou/doc-editor-only-singletons
Document how some editor classes should be accessed as singletons only
2020-04-23 12:06:06 +02:00

77 lines
2.3 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorInspector" inherits="ScrollContainer" version="4.0">
<brief_description>
A tab used to edit properties of the selected node.
</brief_description>
<description>
The editor inspector is by default located on the right-hand side of the editor. It's used to edit the properties of the selected node. For example, you can select a node such as the Sprite2D then edit its transform through the inspector tool. The editor inspector is an essential tool in the game development workflow.
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_inspector].
</description>
<tutorials>
</tutorials>
<methods>
<method name="refresh">
<return type="void">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="scroll_horizontal_enabled" type="bool" setter="set_enable_h_scroll" getter="is_h_scroll_enabled" override="true" default="false" />
</members>
<signals>
<signal name="object_id_selected">
<argument index="0" name="id" type="int">
</argument>
<description>
</description>
</signal>
<signal name="property_deleted">
<argument index="0" name="property" type="String">
</argument>
<description>
</description>
</signal>
<signal name="property_edited">
<argument index="0" name="property" type="String">
</argument>
<description>
</description>
</signal>
<signal name="property_keyed">
<argument index="0" name="property" type="String">
</argument>
<description>
</description>
</signal>
<signal name="property_selected">
<argument index="0" name="property" type="String">
</argument>
<description>
</description>
</signal>
<signal name="property_toggled">
<argument index="0" name="property" type="String">
</argument>
<argument index="1" name="checked" type="bool">
</argument>
<description>
</description>
</signal>
<signal name="resource_selected">
<argument index="0" name="res" type="Object">
</argument>
<argument index="1" name="prop" type="String">
</argument>
<description>
</description>
</signal>
<signal name="restart_requested">
<description>
</description>
</signal>
</signals>
<constants>
</constants>
</class>