EditorInspectorPlugin

Inherits: Reference < Object

Plugin for adding custom property editors on inspector.

Description

This plugins allows adding custom property editors to EditorInspector.

Plugins are registered via EditorPlugin.add_inspector_plugin.

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.

Methods

void	add_custom_control ( Control control )
void	add_property_editor ( String property, Control editor )
void	add_property_editor_for_multiple_properties ( String label, PoolStringArray properties, Control editor )
bool	can_handle ( Object object ) virtual
void	parse_begin ( Object object ) virtual
void	parse_category ( Object object, String category ) virtual
void	parse_end ( ) virtual
bool	parse_property ( Object object, int type, String path, int hint, String hint_text, int usage ) virtual

Method Descriptions

void add_custom_control ( Control control )

Adds a custom control, not necessarily a property editor.

void add_property_editor ( String property, Control editor )

Adds a property editor, this must inherit EditorProperty.

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

Adds an editor that allows modifying multiple properties, this must inherit EditorProperty.

bool can_handle ( Object object ) virtual

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 list.

void parse_category ( Object object, String category ) virtual

Called to allow adding controls at the beginning of the category.

void parse_end ( ) virtual

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

bool parse_property ( Object object, int type, String path, int hint, String hint_text, int usage ) virtual

Called to allow adding property specific editors to the inspector. Usually these inherit EditorProperty. Returning true removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one.