2018-05-28 14:53:15 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2021-11-05 15:02:42 +01:00
<class name= "EditorInspectorPlugin" inherits= "Reference" version= "3.5" >
2018-05-28 14:53:15 +02:00
<brief_description >
2019-04-23 21:39:09 +02:00
Plugin for adding custom property editors on inspector.
2018-05-28 14:53:15 +02:00
</brief_description>
<description >
2021-12-25 16:55:03 +01:00
[EditorInspectorPlugin] allows adding custom property editors to [EditorInspector].
2019-11-02 12:14:15 +01:00
When an object is edited, the [method can_handle] function is called and must return [code]true[/code] if the object type is supported.
2019-04-24 07:49:38 +02:00
If supported, the function [method parse_begin] will be called, allowing to place custom controls at the beginning of the class.
Subsequently, the [method parse_category] and [method parse_property] are called for every category and property. They offer the ability to add custom controls to the inspector too.
2021-03-18 12:04:28 +01:00
Finally, [method parse_end] will be called.
2019-04-24 07:49:38 +02:00
On each of these calls, the "add" functions can be called.
2021-12-25 16:55:03 +01:00
To use [EditorInspectorPlugin], register it using the [method EditorPlugin.add_inspector_plugin] method first.
2018-05-28 14:53:15 +02:00
</description>
<tutorials >
2021-11-15 17:11:20 +01:00
<link title= "Inspector plugins" > $DOCS_URL/tutorials/plugins/editor/inspector_plugins.html</link>
2018-05-28 14:53:15 +02:00
</tutorials>
<methods >
<method name= "add_custom_control" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "control" type= "Control" />
2018-05-28 14:53:15 +02:00
<description >
2021-08-06 20:01:48 +02:00
Adds a custom control, which is not necessarily a property editor.
2018-05-28 14:53:15 +02:00
</description>
</method>
<method name= "add_property_editor" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "property" type= "String" />
<argument index= "1" name= "editor" type= "Control" />
2018-05-28 14:53:15 +02:00
<description >
2021-08-06 20:01:48 +02:00
Adds a property editor for an individual property. The [code]editor[/code] control must extend [EditorProperty].
2018-05-28 14:53:15 +02:00
</description>
</method>
<method name= "add_property_editor_for_multiple_properties" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "label" type= "String" />
<argument index= "1" name= "properties" type= "PoolStringArray" />
<argument index= "2" name= "editor" type= "Control" />
2018-05-28 14:53:15 +02:00
<description >
2021-08-06 20:01:48 +02:00
Adds an editor that allows modifying multiple properties. The [code]editor[/code] control must extend [EditorProperty].
2018-05-28 14:53:15 +02:00
</description>
</method>
<method name= "can_handle" qualifiers= "virtual" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
<argument index= "0" name= "object" type= "Object" />
2018-05-28 14:53:15 +02:00
<description >
2019-11-02 12:14:15 +01:00
Returns [code]true[/code] if this object can be handled by this plugin.
2018-05-28 14:53:15 +02:00
</description>
</method>
<method name= "parse_begin" qualifiers= "virtual" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "object" type= "Object" />
2018-05-28 14:53:15 +02:00
<description >
2019-04-23 21:39:09 +02:00
Called to allow adding controls at the beginning of the list.
2018-05-28 14:53:15 +02:00
</description>
</method>
<method name= "parse_category" qualifiers= "virtual" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "object" type= "Object" />
<argument index= "1" name= "category" type= "String" />
2018-05-28 14:53:15 +02:00
<description >
2019-04-23 21:39:09 +02:00
Called to allow adding controls at the beginning of the category.
2018-05-28 14:53:15 +02:00
</description>
</method>
<method name= "parse_end" qualifiers= "virtual" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2018-05-28 14:53:15 +02:00
<description >
2019-04-23 21:39:09 +02:00
Called to allow adding controls at the end of the list.
2018-05-28 14:53:15 +02:00
</description>
</method>
<method name= "parse_property" qualifiers= "virtual" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
<argument index= "0" name= "object" type= "Object" />
<argument index= "1" name= "type" type= "int" />
<argument index= "2" name= "path" type= "String" />
<argument index= "3" name= "hint" type= "int" />
<argument index= "4" name= "hint_text" type= "String" />
<argument index= "5" name= "usage" type= "int" />
2018-05-28 14:53:15 +02:00
<description >
2020-01-26 01:03:17 +01:00
Called to allow adding property specific editors to the inspector. Usually these inherit [EditorProperty]. Returning [code]true[/code] removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one.
2018-05-28 14:53:15 +02:00
</description>
</method>
</methods>
<constants >
</constants>
</class>