:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorResourcePicker.xml. .. _class_EditorResourcePicker: EditorResourcePicker ==================== **Inherits:** :ref:`HBoxContainer` **<** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`EditorScriptPicker` Godot editor's control for selecting :ref:`Resource` type properties. .. rst-class:: classref-introduction-group Description ----------- This :ref:`Control` node is used in the editor's Inspector dock to allow editing of :ref:`Resource` type properties. It provides options for creating, loading, saving and converting resources. Can be used with :ref:`EditorInspectorPlugin` to recreate the same behavior. \ **Note:** This :ref:`Control` does not include any editor for the resource, as editing is controlled by the Inspector dock itself or sub-Inspectors. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------+-----------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`base_type` | ``""`` | +---------------------------------+-----------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`editable` | ``true`` | +---------------------------------+-----------------------------------------------------------------------------+-----------+ | :ref:`Resource` | :ref:`edited_resource` | | +---------------------------------+-----------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`toggle_mode` | ``false`` | +---------------------------------+-----------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_handle_menu_selected`\ (\ id\: :ref:`int`\ ) |virtual| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_set_create_options`\ (\ menu_node\: :ref:`Object`\ ) |virtual| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_allowed_types`\ (\ ) |const| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_toggle_pressed`\ (\ pressed\: :ref:`bool`\ ) | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_EditorResourcePicker_signal_resource_changed: .. rst-class:: classref-signal **resource_changed**\ (\ resource\: :ref:`Resource`\ ) :ref:`🔗` Emitted when the value of the edited resource was changed. .. rst-class:: classref-item-separator ---- .. _class_EditorResourcePicker_signal_resource_selected: .. rst-class:: classref-signal **resource_selected**\ (\ resource\: :ref:`Resource`, inspect\: :ref:`bool`\ ) :ref:`🔗` Emitted when the resource value was set and user clicked to edit it. When ``inspect`` is ``true``, the signal was caused by the context menu "Edit" or "Inspect" option. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_EditorResourcePicker_property_base_type: .. rst-class:: classref-property :ref:`String` **base_type** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_base_type**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_base_type**\ (\ ) The base type of allowed resource types. Can be a comma-separated list of several options. .. rst-class:: classref-item-separator ---- .. _class_EditorResourcePicker_property_editable: .. rst-class:: classref-property :ref:`bool` **editable** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_editable**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_editable**\ (\ ) If ``true``, the value can be selected and edited. .. rst-class:: classref-item-separator ---- .. _class_EditorResourcePicker_property_edited_resource: .. rst-class:: classref-property :ref:`Resource` **edited_resource** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_edited_resource**\ (\ value\: :ref:`Resource`\ ) - :ref:`Resource` **get_edited_resource**\ (\ ) The edited resource value. .. rst-class:: classref-item-separator ---- .. _class_EditorResourcePicker_property_toggle_mode: .. rst-class:: classref-property :ref:`bool` **toggle_mode** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_toggle_mode**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_toggle_mode**\ (\ ) If ``true``, the main button with the resource preview works in the toggle mode. Use :ref:`set_toggle_pressed()` to manually set the state. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_EditorResourcePicker_private_method__handle_menu_selected: .. rst-class:: classref-method :ref:`bool` **_handle_menu_selected**\ (\ id\: :ref:`int`\ ) |virtual| :ref:`🔗` This virtual method can be implemented to handle context menu items not handled by default. See :ref:`_set_create_options()`. .. rst-class:: classref-item-separator ---- .. _class_EditorResourcePicker_private_method__set_create_options: .. rst-class:: classref-method |void| **_set_create_options**\ (\ menu_node\: :ref:`Object`\ ) |virtual| :ref:`🔗` This virtual method is called when updating the context menu of **EditorResourcePicker**. Implement this method to override the "New ..." items with your own options. ``menu_node`` is a reference to the :ref:`PopupMenu` node. \ **Note:** Implement :ref:`_handle_menu_selected()` to handle these custom items. .. rst-class:: classref-item-separator ---- .. _class_EditorResourcePicker_method_get_allowed_types: .. rst-class:: classref-method :ref:`PackedStringArray` **get_allowed_types**\ (\ ) |const| :ref:`🔗` Returns a list of all allowed types and subtypes corresponding to the :ref:`base_type`. If the :ref:`base_type` is empty, an empty list is returned. .. rst-class:: classref-item-separator ---- .. _class_EditorResourcePicker_method_set_toggle_pressed: .. rst-class:: classref-method |void| **set_toggle_pressed**\ (\ pressed\: :ref:`bool`\ ) :ref:`🔗` Sets the toggle mode state for the main button. Works only if :ref:`toggle_mode` is set to ``true``. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`