godot-docs/classes/class_editorproperty.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the EditorProperty.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_EditorProperty:

EditorProperty
==============

**Inherits:** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

Custom control to edit properties for adding into the inspector

Properties
----------

+-----------------------------+-----------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`checkable<class_EditorProperty_property_checkable>` |
+-----------------------------+-----------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`checked<class_EditorProperty_property_checked>`     |
+-----------------------------+-----------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`draw_red<class_EditorProperty_property_draw_red>`   |
+-----------------------------+-----------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`keying<class_EditorProperty_property_keying>`       |
+-----------------------------+-----------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`label<class_EditorProperty_property_label>`         |
+-----------------------------+-----------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`read_only<class_EditorProperty_property_read_only>` |
+-----------------------------+-----------------------------------------------------------+

Methods
-------

+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                        | :ref:`add_focusable<class_EditorProperty_method_add_focusable>` **(** :ref:`Control<class_Control>` control **)**                                                                                                                 |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                        | :ref:`emit_changed<class_EditorProperty_method_emit_changed>` **(** :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value, :ref:`String<class_String>` field="", :ref:`bool<class_bool>` changing=false **)** |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_Object>` | :ref:`get_edited_object<class_EditorProperty_method_get_edited_object>` **(** **)**                                                                                                                                               |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_edited_property<class_EditorProperty_method_get_edited_property>` **(** **)**                                                                                                                                           |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_tooltip_text<class_EditorProperty_method_get_tooltip_text>` **(** **)** const                                                                                                                                           |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                        | :ref:`set_bottom_editor<class_EditorProperty_method_set_bottom_editor>` **(** :ref:`Control<class_Control>` editor **)**                                                                                                          |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                        | :ref:`update_property<class_EditorProperty_method_update_property>` **(** **)** virtual                                                                                                                                           |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Signals
-------

.. _class_EditorProperty_signal_multiple_properties_changed:

- **multiple_properties_changed** **(** :ref:`PoolStringArray<class_PoolStringArray>` properties, :ref:`Array<class_Array>` value **)**

Emit yourself if you want multiple properties modified at the same time. Do not use if added via :ref:`EditorInspectorPlugin.parse_property<class_EditorInspectorPlugin_method_parse_property>`

.. _class_EditorProperty_signal_object_id_selected:

- **object_id_selected** **(** :ref:`String<class_String>` property, :ref:`int<class_int>` id **)**

Used by sub-inspectors. Emit if what was selected was an Object ID.

.. _class_EditorProperty_signal_property_changed:

- **property_changed** **(** :ref:`String<class_String>` property, :ref:`Nil<class_Nil>` value **)**

Do not emit this manually, use the :ref:`emit_changed<class_EditorProperty_method_emit_changed>` method instead.

.. _class_EditorProperty_signal_property_checked:

- **property_checked** **(** :ref:`String<class_String>` property, :ref:`String<class_String>` bool **)**

Used internally, when a property was checked.

.. _class_EditorProperty_signal_property_keyed:

- **property_keyed** **(** :ref:`String<class_String>` property **)**

Emit if you want to add this value as an animation key (check keying being enabled first).

.. _class_EditorProperty_signal_property_keyed_with_value:

- **property_keyed_with_value** **(** :ref:`String<class_String>` property, :ref:`Nil<class_Nil>` value **)**

Emit if you want to key a property with a single value.

.. _class_EditorProperty_signal_resource_selected:

- **resource_selected** **(** :ref:`String<class_String>` path, :ref:`Resource<class_Resource>` resource **)**

If you want a sub-resource to be edited, emit this signal with the resource.

.. _class_EditorProperty_signal_selected:

- **selected** **(** :ref:`String<class_String>` path, :ref:`int<class_int>` focusable_idx **)**

Internal, used when selected.

Description
-----------

This control allows property editing for one or multiple properties into :ref:`EditorInspector<class_EditorInspector>`. It is added via :ref:`EditorInspectorPlugin<class_EditorInspectorPlugin>`.

Property Descriptions
---------------------

.. _class_EditorProperty_property_checkable:

- :ref:`bool<class_bool>` **checkable**

+----------+----------------------+
| *Setter* | set_checkable(value) |
+----------+----------------------+
| *Getter* | is_checkable()       |
+----------+----------------------+

Used by the inspector, set when property is checkable.

.. _class_EditorProperty_property_checked:

- :ref:`bool<class_bool>` **checked**

+----------+--------------------+
| *Setter* | set_checked(value) |
+----------+--------------------+
| *Getter* | is_checked()       |
+----------+--------------------+

Used by the inspector, when the property is checked.

.. _class_EditorProperty_property_draw_red:

- :ref:`bool<class_bool>` **draw_red**

+----------+---------------------+
| *Setter* | set_draw_red(value) |
+----------+---------------------+
| *Getter* | is_draw_red()       |
+----------+---------------------+

Used by the inspector, when the property must draw with error color.

.. _class_EditorProperty_property_keying:

- :ref:`bool<class_bool>` **keying**

+----------+-------------------+
| *Setter* | set_keying(value) |
+----------+-------------------+
| *Getter* | is_keying()       |
+----------+-------------------+

Used by the inspector, when the property can add keys for animation/

.. _class_EditorProperty_property_label:

- :ref:`String<class_String>` **label**

+----------+------------------+
| *Setter* | set_label(value) |
+----------+------------------+
| *Getter* | get_label()      |
+----------+------------------+

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

.. _class_EditorProperty_property_read_only:

- :ref:`bool<class_bool>` **read_only**

+----------+----------------------+
| *Setter* | set_read_only(value) |
+----------+----------------------+
| *Getter* | is_read_only()       |
+----------+----------------------+

Used by the inspector, when the property is read-only.

Method Descriptions
-------------------

.. _class_EditorProperty_method_add_focusable:

- void **add_focusable** **(** :ref:`Control<class_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.

.. _class_EditorProperty_method_emit_changed:

- void **emit_changed** **(** :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value, :ref:`String<class_String>` field="", :ref:`bool<class_bool>` changing=false **)**

If one (or many properties) changed, this must be called. "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).

.. _class_EditorProperty_method_get_edited_object:

- :ref:`Object<class_Object>` **get_edited_object** **(** **)**

Get the edited object.

.. _class_EditorProperty_method_get_edited_property:

- :ref:`String<class_String>` **get_edited_property** **(** **)**

Get the edited property. If your editor is for a single property (added via :ref:`EditorInspectorPlugin.parse_property<class_EditorInspectorPlugin_method_parse_property>`), then this will return it..

.. _class_EditorProperty_method_get_tooltip_text:

- :ref:`String<class_String>` **get_tooltip_text** **(** **)** const

Override if you want to allow a custom tooltip over your property.

.. _class_EditorProperty_method_set_bottom_editor:

- void **set_bottom_editor** **(** :ref:`Control<class_Control>` editor **)**

Add controls with this function if you want them on the bottom (below the label).

.. _class_EditorProperty_method_update_property:

- void **update_property** **(** **)** virtual

When this virtual function is called, you must update your editor.