Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

EditorInspectorPlugin¶

Plugin for adding custom property editors on the inspector.

Description¶

EditorInspectorPlugin allows adding custom property editors to EditorInspector.

When an object is edited, the _can_handle function is called and must return true 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 use EditorInspectorPlugin, register it using the EditorPlugin.add_inspector_plugin method first.

Tutorials¶

Inspector plugins

Methods¶

bool	_can_handle ( Object object ) virtual const
void	_parse_begin ( Object object ) virtual
void	_parse_category ( Object object, String category ) virtual
void	_parse_end ( Object object ) virtual
void	_parse_group ( Object object, String group ) virtual
bool	_parse_property ( Object object, Variant.Type type, String name, PropertyHint hint_type, String hint_string, BitField<PropertyUsageFlags> usage_flags, bool wide ) virtual
void	add_custom_control ( Control control )
void	add_property_editor ( String property, Control editor, bool add_to_end=false )
void	add_property_editor_for_multiple_properties ( String label, PackedStringArray properties, Control editor )

Method Descriptions¶

bool _can_handle ( Object object ) virtual const

Returns true 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 for object.

void _parse_category ( Object object, String category ) virtual

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

void _parse_end ( Object object ) virtual

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

void _parse_group ( Object object, String group ) virtual

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

bool _parse_property ( Object object, Variant.Type type, String name, PropertyHint hint_type, String hint_string, BitField<PropertyUsageFlags> usage_flags, bool wide ) virtual

Called to allow adding property-specific editors to the property list for object. The added editor control must extend EditorProperty. Returning true removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one.

void add_custom_control ( Control control )

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

void add_property_editor ( String property, Control editor, bool add_to_end=false )

Adds a property editor for an individual property. The editor control must extend EditorProperty.

void add_property_editor_for_multiple_properties ( String label, PackedStringArray properties, Control editor )

Adds an editor that allows modifying multiple properties. The editor control must extend EditorProperty.