跳到主要内容

EditorInspectorPlugin

继承

Reference

简要描述

用于在检查器上添加自定义属性编辑器的插件。

描述

此插件允许将自定义属性编辑器添加到EditorInspector

插件是通过EditorPlugin.add_inspector_plugin注册的。

编辑对象时,将调用can_handle函数,并且如果该对象类型支持,则必须返回true

如果支持,将调用函数parse_begin,从而将自定义控件放置在类的开头。

随后,为每个类别和属性调用parse_categoryparse_property。它们还提供了将自定义控件添加到检查器的功能。

最后,parse_end将被调用。

在每个这些调用中,都可以调用“添加”功能。

方法

返回值类型方法名称
voidadd_custom_control(control: Control)
voidadd_property_editor(property: String, editor: Control)
voidadd_property_editor_for_multiple_properties(label: String, properties: PoolStringArray, editor: Control)
boolcan_handle(object: Object) virtual
voidparse_begin(object: Object) virtual
voidparse_category(object: Object, category: String) virtual
voidparse_end() virtual
boolparse_property(object: Object, type: int, path: String, hint: int, hint_text: String, usage: int) virtual

方法说明

  • add_custom_control add_custom_control(control: Control)

添加一个自定义控件,不一定是属性编辑器。


  • add_property_editor add_property_editor(property: String, editor: Control)

添加一个属性编辑器,该属性必须继承EditorProperty


  • add_property_editor_for_multiple_properties add_property_editor_for_multiple_properties(label: String, properties: PoolStringArray, editor: Control)

添加一个允许修改多个属性的编辑器,该编辑器必须继承EditorProperty


  • can_handle can_handle(object: Object) virtual

如果此插件可以处理此对象,则返回true


  • parse_begin parse_begin(object: Object) virtual

调用以允许在列表的开头添加控件。


  • parse_category parse_category(object: Object, category: String) virtual

调用以允许在类别的开头添加控件。


  • parse_end parse_end() virtual

调用以允许在列表末尾添加控件。


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

调用以允许将特定于属性的编辑器添加到检查器。通常这些会继承EditorProperty。返回true将删除此属性的内置编辑器,否则允许在内置编辑器之前插入自定义编辑器。