Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

EditorPlugin

Inherits: Node < Object

Used by the editor to extend its functionality.

Description

Plugins are used by the editor to extend functionality. The most common types of plugins are those which edit a given node or resource type, import plugins and export plugins. See also EditorScript to add functions to the editor.

Note: Some names in this class contain "left" or "right" (e.g. DOCK_SLOT_LEFT_UL). These APIs assume left-to-right layout, and would be backwards when using right-to-left layout. These names are kept for compatibility reasons.

Tutorials

• Editor plugins documentation index

Methods

void	_apply_changes ( ) virtual
bool	_build ( ) virtual
void	_clear ( ) virtual
void	_disable_plugin ( ) virtual
void	_edit ( Object object ) virtual
void	_enable_plugin ( ) virtual
void	_forward_3d_draw_over_viewport ( Control viewport_control ) virtual
void	_forward_3d_force_draw_over_viewport ( Control viewport_control ) virtual
int	_forward_3d_gui_input ( Camera3D viewport_camera, InputEvent event ) virtual
void	_forward_canvas_draw_over_viewport ( Control viewport_control ) virtual
void	_forward_canvas_force_draw_over_viewport ( Control viewport_control ) virtual
bool	_forward_canvas_gui_input ( InputEvent event ) virtual
PackedStringArray	_get_breakpoints ( ) virtual const
Texture2D	_get_plugin_icon ( ) virtual const
String	_get_plugin_name ( ) virtual const
Dictionary	_get_state ( ) virtual const
String	_get_unsaved_status ( String for_scene ) virtual const
void	_get_window_layout ( ConfigFile configuration ) virtual
bool	_handles ( Object object ) virtual const
bool	_has_main_screen ( ) virtual const
void	_make_visible ( bool visible ) virtual
void	_save_external_data ( ) virtual
void	_set_state ( Dictionary state ) virtual
void	_set_window_layout ( ConfigFile configuration ) virtual
void	add_autoload_singleton ( String name, String path )
Button	add_control_to_bottom_panel ( Control control, String title )
void	add_control_to_container ( CustomControlContainer container, Control control )
void	add_control_to_dock ( DockSlot slot, Control control )
void	add_custom_type ( String type, String base, Script script, Texture2D icon )
void	add_debugger_plugin ( EditorDebuggerPlugin script )
void	add_export_plugin ( EditorExportPlugin plugin )
void	add_import_plugin ( EditorImportPlugin importer, bool first_priority=false )
void	add_inspector_plugin ( EditorInspectorPlugin plugin )
void	add_node_3d_gizmo_plugin ( EditorNode3DGizmoPlugin plugin )
void	add_resource_conversion_plugin ( EditorResourceConversionPlugin plugin )
void	add_scene_format_importer_plugin ( EditorSceneFormatImporter scene_format_importer, bool first_priority=false )
void	add_scene_post_import_plugin ( EditorScenePostImportPlugin scene_import_plugin, bool first_priority=false )
void	add_tool_menu_item ( String name, Callable callable )
void	add_tool_submenu_item ( String name, PopupMenu submenu )
void	add_translation_parser_plugin ( EditorTranslationParserPlugin parser )
void	add_undo_redo_inspector_hook_callback ( Callable callable )
EditorInterface	get_editor_interface ( )
PopupMenu	get_export_as_menu ( )
String	get_plugin_version ( ) const
ScriptCreateDialog	get_script_create_dialog ( )
EditorUndoRedoManager	get_undo_redo ( )
void	hide_bottom_panel ( )
void	make_bottom_panel_item_visible ( Control item )
void	queue_save_layout ( )
void	remove_autoload_singleton ( String name )
void	remove_control_from_bottom_panel ( Control control )
void	remove_control_from_container ( CustomControlContainer container, Control control )
void	remove_control_from_docks ( Control control )
void	remove_custom_type ( String type )
void	remove_debugger_plugin ( EditorDebuggerPlugin script )
void	remove_export_plugin ( EditorExportPlugin plugin )
void	remove_import_plugin ( EditorImportPlugin importer )
void	remove_inspector_plugin ( EditorInspectorPlugin plugin )
void	remove_node_3d_gizmo_plugin ( EditorNode3DGizmoPlugin plugin )
void	remove_resource_conversion_plugin ( EditorResourceConversionPlugin plugin )
void	remove_scene_format_importer_plugin ( EditorSceneFormatImporter scene_format_importer )
void	remove_scene_post_import_plugin ( EditorScenePostImportPlugin scene_import_plugin )
void	remove_tool_menu_item ( String name )
void	remove_translation_parser_plugin ( EditorTranslationParserPlugin parser )
void	remove_undo_redo_inspector_hook_callback ( Callable callable )
void	set_force_draw_over_forwarding_enabled ( )
void	set_input_event_forwarding_always_enabled ( )
int	update_overlays ( ) const

---

Signals

main_screen_changed ( String screen_name )

Emitted when user changes the workspace (2D, 3D, Script, AssetLib). Also works with custom screens defined by plugins.

---

project_settings_changed ( )

Emitted when any project setting has changed.

Deprecated. Use ProjectSettings.settings_changed instead.

---

resource_saved ( Resource resource )

Emitted when the given resource was saved on disc.

---

scene_changed ( Node scene_root )

Emitted when the scene is changed in the editor. The argument will return the root node of the scene that has just become active. If this scene is new and empty, the argument will be null.

---

scene_closed ( String filepath )

Emitted when user closes a scene. The argument is file path to a closed scene.

---

Enumerations

enum CustomControlContainer:

CustomControlContainer CONTAINER_TOOLBAR = 0

Main editor toolbar, next to play buttons.

CustomControlContainer CONTAINER_SPATIAL_EDITOR_MENU = 1

The toolbar that appears when 3D editor is active.

CustomControlContainer CONTAINER_SPATIAL_EDITOR_SIDE_LEFT = 2

Left sidebar of the 3D editor.

CustomControlContainer CONTAINER_SPATIAL_EDITOR_SIDE_RIGHT = 3

Right sidebar of the 3D editor.