Description

EditorInspectorPlugin allows adding custom property editors toEditorInspector.

When an object is edited, the_can_handle() function is called and must returntrue if the object type is supported.

If supported, the function_parse_begin() will be called, allowing to place custom controls at the beginning of the class.

Subsequently, the_parse_category() and_parse_property() are called for every category and property. They offer the ability to add custom controls to the inspector too.

Finally,_parse_end() will be called.

On each of these calls, the "add" functions can be called.

To useEditorInspectorPlugin, register it using theEditorPlugin.add_inspector_plugin() method first.

Tutorials

• Inspector plugins

Methods

Method Descriptions

bool_can_handle(object:Object)virtualconst🔗

Returnstrue if this object can be handled by this plugin.

void_parse_begin(object:Object)virtual🔗

Called to allow adding controls at the beginning of the property list forobject.

void_parse_category(object:Object, category:String)virtual🔗

Called to allow adding controls at the beginning of a category in the property list forobject.

void_parse_end(object:Object)virtual🔗

Called to allow adding controls at the end of the property list forobject.

void_parse_group(object:Object, group:String)virtual🔗

Called to allow adding controls at the beginning of a group or a sub-group in the property list forobject.

bool_parse_property(object:Object, type:Variant.Type, name:String, hint_type:PropertyHint, hint_string:String, usage_flags:BitField[PropertyUsageFlags], wide:bool)virtual🔗

Called to allow adding property-specific editors to the property list forobject. The added editor control must extendEditorProperty. Returningtrue removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one.

voidadd_custom_control(control:Control)🔗

Adds a custom control, which is not necessarily a property editor.

voidadd_property_editor(property:String, editor:Control, add_to_end:bool = false, label:String = "")🔗

Adds a property editor for an individual property. Theeditor control must extendEditorProperty.

There can be multiple property editors for a property. Ifadd_to_end istrue, this newly added editor will be displayed after all the other editors of the property whoseadd_to_end isfalse. For example, the editor uses this parameter to add an "Edit Region" button forSprite2D.region_rect below the regularRect2 editor.

label can be used to choose a custom label for the property editor in the inspector. If left empty, the label is computed from the name of the property instead.

voidadd_property_editor_for_multiple_properties(label:String, properties:PackedStringArray, editor:Control)🔗

Adds an editor that allows modifying multiple properties. Theeditor control must extendEditorProperty.