跳到主要内容

EditorProperty

继承

Container

简要描述

自定义控件,用于编辑要添加到检查器中的属性。

描述

此控件允许将一个或多个属性的属性编辑到EditorInspector中。它是通过EditorInspectorPlugin添加的。

成员

类型属性名默认值
boolcheckablefalse
boolcheckedfalse
booldraw_redfalse
boolkeyingfalse
Stringlabel""
boolread_onlyfalse

方法

返回值类型方法名称
voidadd_focusable(control: Control)
voidemit_changed(property: String, value: Variant, field: String = "", changing: bool = false)
Objectget_edited_object()
Stringget_edited_property()
Stringget_tooltip_text() const
voidset_bottom_editor(editor: Control)
voidupdate_property() virtual

信号

  • **multiple_properties_changed**

如果要同时修改多个属性,请发出它。如果通过EditorInspectorPlugin.parse_property添加,则不要使用。


  • **object_id_selected**

由子检查器使用。如果选择的是对象ID,则发出它。


  • **property_changed**

不要手动发出此命令,而应使用generate_changed方法。


  • **property_checked**

在检查属性时发出。内部使用。


  • **property_keyed**

如果要将此值添加为动画关键帧,则发出它(检查是否先启用关键帧)。


  • **property_keyed_with_value**

如果要使用单个值键属性,请发出它。


  • **resource_selected**

如果要编辑子资源,请与资源一起发出此信号。


  • **selected**

选定时发射。内部使用。


常量

成员说明

  • bool checkable
Defaultfalse
setterset_checkable(value)
getteris_checkable
  • bool checked
Defaultfalse
setterset_checked(value)
getteris_checked
  • bool draw_red
Defaultfalse
setterset_draw_red(value)
getteris_draw_red
  • bool keying
Defaultfalse
setterset_keying(value)
getteris_keying
  • String label
Default""
setterset_label(value)
getterget_label
  • bool read_only
Defaultfalse
setterset_read_only(value)
getteris_read_only

方法说明

  • add_focusable add_focusable(control: Control)

如果添加的任何控件都能获得键盘焦点,请在此处添加它。这样可以确保在刷新检查器时可以将焦点恢复。


  • emit_changed emit_changed(property: String, value: Variant, field: String = "", changing: bool = false)

如果一个或多个属性已更改,则必须调用它。field用于您的编辑器可以单独修改字段的情况(例如,Vector3.x)。changing参数避免了编辑器请求刷新此属性(如果不确定则设为false)。


  • get_edited_object get_edited_object()

获取编辑的对象。


  • get_edited_property get_edited_property()

获取已编辑的属性。如果您的编辑器用于单个属性(通过EditorInspectorPlugin.parse_property添加),则将返回该属性。


  • get_tooltip_text get_tooltip_text() const

如果要允许在属性上使用自定义工具提示,则覆盖。


  • set_bottom_editor set_bottom_editor(editor: Control)

如果要在底部(标签下方)添加控件,请使用此功能。


  • update_property update_property() virtual

调用此虚拟函数时,必须更新编辑器。