EditorProperty

Inherits: Container < Control < CanvasItem < Node < Object Custom control to edit properties for adding into the inspector.

Description

EditorInspector. It is added via EditorInspectorPlugin.

Properties

Methods

Signals

• multiple_properties_changed ( PoolStringArray properties, Array value ) EditorInspectorPlugin.parse_property.

• object_id_selected ( String property, int id ) Used by sub-inspectors. Emit it if what was selected was an Object ID.

• property_changed ( String property, Variant value ) emit_changed method instead.

• property_checked ( String property, String bool ) Emitted when a property was checked. Used internally.

• property_keyed ( String property ) Emit it if you want to add this value as an animation key (check for keying being enabled first).

• property_keyed_with_value ( String property, Variant value ) Emit it if you want to key a property with a single value.

• resource_selected ( String path, Resource resource ) If you want a sub-resource to be edited, emit this signal with the resource.

• selected ( String path, int focusable_idx ) Emitted when selected. Used internally.

  Property Descriptions

• bool checkable true when the property is checkable.

• bool checked true when the property is checked.

• bool draw_red true when the property is drawn with the editor theme’s warning color. This is used for editable children’s properties.

• bool keying true when the property can add keys for animation.

• String label Set this property to change the label (if you want to show one).

• bool read_only true when the property is read-only.

  Method Descriptions

• add_focusable ( Control control ) If any of the controls added can gain keyboard focus, add it here. This ensures that focus will be restored if the inspector is refreshed.

• emit_changed ( String property, Variant value, String field=””, bool changing=false ) field is used in case your editor can modify fields separately (as an example, Vector3.x). The changing argument avoids the editor requesting this property to be refreshed (leave as false if unsure).

• Object get_edited_object ( ) Gets the edited object.

• String get_edited_property ( ) EditorInspectorPlugin.parse_property), then this will return the property.

• String get_tooltip_text ( ) const Must be implemented to provide a custom tooltip to the property editor.

• set_bottom_editor ( Control editor ) editor control below the property label. The control must be previously added using Node.add_child.

• update_property ( ) virtual When this virtual function is called, you must update your editor.