mirror of
https://github.com/Relintai/pandemonium_engine_minimal.git
synced 2024-12-21 16:56:50 +01:00
193 lines
7.2 KiB
XML
193 lines
7.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="EditorInspector" inherits="ScrollContainer" version="4.2">
|
|
<brief_description>
|
|
A control used to edit properties of an object.
|
|
</brief_description>
|
|
<description>
|
|
This is the control that implements property editing in the editor's Settings dialogs, the Inspector dock, etc. To get the [EditorInspector] used in the editor's Inspector dock, use [method EditorInterface.get_inspector].
|
|
[EditorInspector] will show properties in the same order as the array returned by [method Object.get_property_list].
|
|
If a property's name is path-like (i.e. if it contains forward slashes), [EditorInspector] will create nested sections for "directories" along the path. For example, if a property is named [code]highlighting/gdscript/node_path_color[/code], it will be shown as "Node Path Color" inside the "GDScript" section nested inside the "Highlighting" section.
|
|
If a property has [constant @GlobalScope.PROPERTY_USAGE_GROUP] usage, it will group subsequent properties whose name starts with the property's hint string. The group ends when a property does not start with that hint string or when a new group starts. An empty group name effectively ends the current group. [EditorInspector] will create a top-level section for each group. For example, if a property with group usage is named [code]Collide With[/code] and its hint string is [code]collide_with_[/code], a subsequent [code]collide_with_area[/code] property will be shown as "Area" inside the "Collide With" section.
|
|
[b]Note:[/b] Unlike sections created from path-like property names, [EditorInspector] won't capitalize the name for sections created from groups. So properties with group usage usually use capitalized names instead of snake_cased names.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="collapse_all_folding">
|
|
<return type="void" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="edit">
|
|
<return type="void" />
|
|
<argument index="0" name="object" type="Object" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="expand_all_folding">
|
|
<return type="void" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_edited_object">
|
|
<return type="Object" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_object_class" qualifiers="const">
|
|
<return type="String" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_property_clipboard" qualifiers="const">
|
|
<return type="Variant" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_property_prefix" qualifiers="const">
|
|
<return type="String" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_scroll_offset" qualifiers="const">
|
|
<return type="int" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="is_sub_inspector" qualifiers="const">
|
|
<return type="bool" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="is_using_folding">
|
|
<return type="bool" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="refresh">
|
|
<return type="void" />
|
|
<description>
|
|
Refreshes the inspector.
|
|
[b]Note:[/b] To save on CPU resources, calling this method will do nothing if the time specified in [code]docks/property_editor/auto_refresh_interval[/code] editor setting hasn't passed yet since this method was last called. (By default, this interval is set to 0.3 seconds.)
|
|
</description>
|
|
</method>
|
|
<method name="register_text_enter">
|
|
<return type="void" />
|
|
<argument index="0" name="line_edit" type="Node" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_hide_script">
|
|
<return type="void" />
|
|
<argument index="0" name="hide" type="bool" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_object_class">
|
|
<return type="void" />
|
|
<argument index="0" name="class" type="String" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_property_clipboard">
|
|
<return type="void" />
|
|
<argument index="0" name="value" type="Variant" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_property_prefix">
|
|
<return type="void" />
|
|
<argument index="0" name="prefix" type="String" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_scroll_offset">
|
|
<return type="void" />
|
|
<argument index="0" name="offset" type="int" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_show_categories">
|
|
<return type="void" />
|
|
<argument index="0" name="show" type="bool" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_sub_inspector">
|
|
<return type="void" />
|
|
<argument index="0" name="enable" type="bool" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_use_doc_hints">
|
|
<return type="void" />
|
|
<argument index="0" name="enable" type="bool" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_use_filter">
|
|
<return type="void" />
|
|
<argument index="0" name="use" type="bool" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_use_folding">
|
|
<return type="void" />
|
|
<argument index="0" name="enable" type="bool" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="scroll_horizontal_enabled" type="bool" setter="set_enable_h_scroll" getter="is_h_scroll_enabled" overrides="ScrollContainer" default="false" />
|
|
</members>
|
|
<signals>
|
|
<signal name="object_id_selected">
|
|
<argument index="0" name="id" type="int" />
|
|
<description>
|
|
Emitted when the Edit button of an [Object] has been pressed in the inspector. This is mainly used in the remote scene tree inspector.
|
|
</description>
|
|
</signal>
|
|
<signal name="property_edited">
|
|
<argument index="0" name="property" type="String" />
|
|
<description>
|
|
Emitted when a property is edited in the inspector.
|
|
</description>
|
|
</signal>
|
|
<signal name="property_keyed">
|
|
<argument index="0" name="property" type="String" />
|
|
<description>
|
|
Emitted when a property is keyed in the inspector. Properties can be keyed by clicking the "key" icon next to a property when the Animation panel is toggled.
|
|
</description>
|
|
</signal>
|
|
<signal name="property_selected">
|
|
<argument index="0" name="property" type="String" />
|
|
<description>
|
|
Emitted when a property is selected in the inspector.
|
|
</description>
|
|
</signal>
|
|
<signal name="property_toggled">
|
|
<argument index="0" name="property" type="String" />
|
|
<argument index="1" name="checked" type="bool" />
|
|
<description>
|
|
Emitted when a boolean property is toggled in the inspector.
|
|
[b]Note:[/b] This signal is never emitted if the internal [code]autoclear[/code] property enabled. Since this property is always enabled in the editor inspector, this signal is never emitted by the editor itself.
|
|
</description>
|
|
</signal>
|
|
<signal name="resource_selected">
|
|
<argument index="0" name="res" type="Object" />
|
|
<argument index="1" name="prop" type="String" />
|
|
<description>
|
|
Emitted when a resource is selected in the inspector.
|
|
</description>
|
|
</signal>
|
|
<signal name="restart_requested">
|
|
<description>
|
|
Emitted when a property that requires a restart to be applied is edited in the inspector. This is only used in the Project Settings and Editor Settings.
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
<constants>
|
|
</constants>
|
|
</class>
|