path: root/doc/classes/EditorPlugin.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorPlugin" inherits="Node" version="4.0">
	<brief_description>
		Used by the editor to extend its functionality.
	</brief_description>
	<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.
	</description>
	<tutorials>
		<link>https://docs.godotengine.org/en/latest/tutorials/plugins/editor/index.html</link>
	</tutorials>
	<methods>
		<method name="add_autoload_singleton">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="path" type="String">
			</argument>
			<description>
				Adds a script at [code]path[/code] to the Autoload list as [code]name[/code].
			</description>
		</method>
		<method name="add_control_to_bottom_panel">
			<return type="ToolButton">
			</return>
			<argument index="0" name="control" type="Control">
			</argument>
			<argument index="1" name="title" type="String">
			</argument>
			<description>
				Adds a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_bottom_panel] and free it with [method Node.queue_free].
			</description>
		</method>
		<method name="add_control_to_container">
			<return type="void">
			</return>
			<argument index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer">
			</argument>
			<argument index="1" name="control" type="Control">
			</argument>
			<description>
				Adds a custom control to a container (see [enum CustomControlContainer]). There are many locations where custom controls can be added in the editor UI.
				Please remember that you have to manage the visibility of your custom controls yourself (and likely hide it after adding it).
				When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_container] and free it with [method Node.queue_free].
			</description>
		</method>
		<method name="add_control_to_dock">
			<return type="void">
			</return>
			<argument index="0" name="slot" type="int" enum="EditorPlugin.DockSlot">
			</argument>
			<argument index="1" name="control" type="Control">
			</argument>
			<description>
				Adds the control to a specific dock slot (see [enum DockSlot] for options).
				If the dock is repositioned and as long as the plugin is active, the editor will save the dock position on further sessions.
				When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_docks] and free it with [method Node.queue_free].
			</description>
		</method>
		<method name="add_custom_type">
			<return type="void">
			</return>
			<argument index="0" name="type" type="String">
			</argument>
			<argument index="1" name="base" type="String">
			</argument>
			<argument index="2" name="script" type="Script">
			</argument>
			<argument index="3" name="icon" type="Texture2D">
			</argument>
			<description>
				Adds a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed.
				When given node or resource is selected, the base type will be instanced (e.g. "Spatial", "Control", "Resource"), then the script will be loaded and set to this object.
				You can use the virtual method [method handles] to check if your custom object is being edited by checking the script or using the [code]is[/code] keyword.
				During run-time, this will be a simple object with a script so this function does not need to be called then.
			</description>
		</method>
		<method name="add_export_plugin">
			<return type="void">
			</return>
			<argument index="0" name="plugin" type="EditorExportPlugin">
			</argument>
			<description>
			</description>
		</method>
		<method name="add_import_plugin">
			<return type="void">
			</return>
			<argument index="0" name="importer" type="EditorImportPlugin">
			</argument>
			<description>
			</description>
		</method>
		<method name="add_inspector_plugin">
			<return type="void">
			</return>
			<argument index="0" name="plugin" type="EditorInspectorPlugin">
			</argument>
			<description>
			</description>
		</method>
		<method name="add_scene_import_plugin">
			<return type="void">
			</return>
			<argument index="0" name="scene_importer" type="EditorSceneImporter">
			</argument>
			<description>
			</description>
		</method>
		<method name="add_spatial_gizmo_plugin">
			<return type="void">
			</return>
			<argument index="0" name="plugin" type="EditorSpatialGizmoPlugin">
			</argument>
			<description>
			</description>
		</method>
		<method name="add_tool_menu_item">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="handler" type="Object">
			</argument>
			<argument index="2" name="callback" type="String">
			</argument>
			<argument index="3" name="ud" type="Variant" default="null">
			</argument>
			<description>
				Adds a custom menu item to [b]Project &gt; Tools[/b] as [code]name[/code] that calls [code]callback[/code] on an instance of [code]handler[/code] with a parameter [code]ud[/code] when user activates it.
			</description>
		</method>
		<method name="add_tool_submenu_item">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="submenu" type="Object">
			</argument>
			<description>
				Adds a custom submenu under [b]Project &gt; Tools &gt;[/b] [code]name[/code]. [code]submenu[/code] should be an object of class [PopupMenu]. This submenu should be cleaned up using [code]remove_tool_menu_item(name)[/code].
			</description>
		</method>
		<method name="apply_changes" qualifiers="virtual">
			<return type="void">
			</return>
			<description>
				This method is called when the editor is about to save the project, switch to another tab, etc. It asks the plugin to apply any pending state changes to ensure consistency.
				This is used, for example, in shader editors to let the plugin know that it must apply the shader code being written by the user to the object.
			</description>
		</method>
		<method name="build" qualifiers="virtual">
			<return type="bool">
			</return>
			<description>
			</description>
		</method>
		<method name="clear" qualifiers="virtual">
			<return type="void">
			</return>
			<description>
				Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node from the wrong scene.
			</description>
		</method>
		<method name="disable_plugin" qualifiers="virtual">
			<return type="void">
			</return>
			<description>
				Called by the engine when the user disables the [EditorPlugin] in the Plugin tab of the project settings window.
			</description>
		</method>
		<method name="edit" qualifiers="virtual">
			<return type="void">
			</return>
			<argument index="0" name="object" type="Object">
			</argument>
			<description>
				This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object.
			</description>
		</method>
		<method name="enable_plugin" qualifiers="virtual">
			<return type="void">
			</return>
			<description>
				Called by the engine when the user enables the [EditorPlugin] in the Plugin tab of the project settings window.
			</description>
		</method>
		<method name="forward_canvas_draw_over_viewport" qualifiers="virtual">
			<return type="void">
			</return>
			<argument index="0" name="overlay" type="Control">
			</argument>
			<description>
			</description>
		</method>
		<method name="forward_canvas_force_draw_over_viewport" qualifiers="virtual">
			<return type="void">
			</return>
			<argument index="0" name="overlay" type="Control">
			</argument>
			<description>
			</description>
		</method>
		<method name="forward_canvas_gui_input" qualifiers="virtual">
			<return type="bool">
			</return>
			<argument index="0" name="event" type="InputEvent">
			</argument>
			<description>
				Called when there is a root node in the current edited scene, [method handles] is implemented and an [InputEvent] happens in the 2D viewport. Intercepts the [InputEvent], if [code]return true[/code] [EditorPlugin] consumes the [code]event[/code], otherwise forwards [code]event[/code] to other Editor classes. Example:
				[codeblock]
				# Prevents the InputEvent to reach other Editor classes
				func forward_canvas_gui_input(event):
				    var forward = true
				    return forward
				[/codeblock]
				Must [code]return false[/code] in order to forward the [InputEvent] to other Editor classes. Example:
				[codeblock]
				# Consumes InputEventMouseMotion and forwards other InputEvent types
				func forward_canvas_gui_input(event):
				    var forward = false
				    if event is InputEventMouseMotion:
				        forward = true
				    return forward
				[/codeblock]
			</description>
		</method>
		<method name="forward_spatial_gui_input" qualifiers="virtual">
			<return type="bool">
			</return>
			<argument index="0" name="camera" type="Camera">
			</argument>
			<argument index="1" name="event" type="InputEvent">
			</argument>
			<description>
				Called when there is a root node in the current edited scene, [method handles] is implemented and an [InputEvent] happens in the 3D viewport. Intercepts the [InputEvent], if [code]return true[/code] [EditorPlugin] consumes the [code]event[/code], otherwise forwards [code]event[/code] to other Editor classes. Example:
				[codeblock]
				# Prevents the InputEvent to reach other Editor classes
				func forward_spatial_gui_input(camera, event):
				    var forward = true
				    return forward
				[/codeblock]
				Must [code]return false[/code] in order to forward the [InputEvent] to other Editor classes. Example:
				[codeblock]
				# Consumes InputEventMouseMotion and forwards other InputEvent types
				func forward_spatial_gui_input(camera, event):
				    var forward = false
				    if event is InputEventMouseMotion:
				        forward = true
				    return forward
				[/codeblock]
			</description>
		</method>
		<method name="get_breakpoints" qualifiers="virtual">
			<return type="PackedStringArray">
			</return>
			<description>
				This is for editors that edit script-based objects. You can return a list of breakpoints in the format ([code]script:line[/code]), for example: [code]res://path_to_script.gd:25[/code].
			</description>
		</method>
		<method name="get_editor_interface">
			<return type="EditorInterface">
			</return>
			<description>
				Returns the [EditorInterface] object that gives you control over Godot editor's window and its functionalities.
			</description>
		</method>
		<method name="get_plugin_icon" qualifiers="virtual">
			<return type="Object">
			</return>
			<description>
			</description>
		</method>
		<method name="get_plugin_name" qualifiers="virtual">
			<return type="String">
			</return>
			<description>
			</description>
		</method>
		<method name="get_script_create_dialog">
			<return type="ScriptCreateDialog">
			</return>
			<description>
				Gets the Editor's dialogue used for making scripts.
				[b]Note:[/b] Users can configure it before use.
			</description>
		</method>
		<method name="get_state" qualifiers="virtual">
			<return type="Dictionary">
			</return>
			<description>
				Gets the state of your plugin editor. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns).
			</description>
		</method>
		<method name="get_undo_redo">
			<return type="UndoRedo">
			</return>
			<description>
				Gets the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it.
			</description>
		</method>
		<method name="get_window_layout" qualifiers="virtual">
			<return type="void">
			</return>
			<argument index="0" name="layout" type="ConfigFile">
			</argument>
			<description>
				Gets the GUI layout of the plugin. This is used to save the project's editor layout when [method queue_save_layout] is called or the editor layout was changed(For example changing the position of a dock).
			</description>
		</method>
		<method name="handles" qualifiers="virtual">
			<return type="bool">
			</return>
			<argument index="0" name="object" type="Object">
			</argument>
			<description>
				Implement this function if your plugin edits a specific type of object (Resource or Node). If you return [code]true[/code], then you will get the functions [method edit] and [method make_visible] called when the editor requests them. If you have declared the methods [method forward_canvas_gui_input] and [method forward_spatial_gui_input] these will be called too.
			</description>
		</method>
		<method name="has_main_screen" qualifiers="virtual">
			<return type="bool">
			</return>
			<description>
				Returns [code]true[/code] if this is a main screen editor plugin (it goes in the workspace selector together with [b]2D[/b], [b]3D[/b], [b]Script[/b] and [b]AssetLib[/b]).
			</description>
		</method>
		<method name="hide_bottom_panel">
			<return type="void">
			</return>
			<description>
			</description>
		</method>
		<method name="make_bottom_panel_item_visible">
			<return type="void">
			</return>
			<argument index="0" name="item" type="Control">
			</argument>
			<description>
			</description>
		</method>
		<method name="make_visible" qualifiers="virtual">
			<return type="void">
			</return>
			<argument index="0" name="visible" type="bool">
			</argument>
			<description>
				This function will be called when the editor is requested to become visible. It is used for plugins that edit a specific object type.
				Remember that you have to manage the visibility of all your editor controls manually.
			</description>
		</method>
		<method name="queue_save_layout" qualifiers="const">
			<return type="void">
			</return>
			<description>
				Queue save the project's editor layout.
			</description>
		</method>
		<method name="remove_autoload_singleton">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<description>
				Removes an Autoload [code]name[/code] from the list.
			</description>
		</method>
		<method name="remove_control_from_bottom_panel">
			<return type="void">
			</return>
			<argument index="0" name="control" type="Control">
			</argument>
			<description>
				Removes the control from the bottom panel. You have to manually [method Node.queue_free] the control.
			</description>
		</method>
		<method name="remove_control_from_container">
			<return type="void">
			</return>
			<argument index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer">
			</argument>
			<argument index="1" name="control" type="Control">
			</argument>
			<description>
				Removes the control from the specified container. You have to manually [method Node.queue_free] the control.
			</description>
		</method>
		<method name="remove_control_from_docks">
			<return type="void">
			</return>
			<argument index="0" name="control" type="Control">
			</argument>
			<description>
				Removes the control from the dock. You have to manually [method Node.queue_free] the control.
			</description>
		</method>
		<method name="remove_custom_type">
			<return type="void">
			</return>
			<argument index="0" name="type" type="String">
			</argument>
			<description>
				Removes a custom type added by [method add_custom_type].
			</description>
		</method>
		<method name="remove_export_plugin">
			<return type="void">
			</return>
			<argument index="0" name="plugin" type="EditorExportPlugin">
			</argument>
			<description>
			</description>
		</method>
		<method name="remove_import_plugin">
			<return type="void">
			</return>
			<argument index="0" name="importer" type="EditorImportPlugin">
			</argument>
			<description>
			</description>
		</method>
		<method name="remove_inspector_plugin">
			<return type="void">
			</return>
			<argument index="0" name="plugin" type="EditorInspectorPlugin">
			</argument>
			<description>
			</description>
		</method>
		<method name="remove_scene_import_plugin">
			<return type="void">
			</return>
			<argument index="0" name="scene_importer" type="EditorSceneImporter">
			</argument>
			<description>
			</description>
		</method>
		<method name="remove_spatial_gizmo_plugin">
			<return type="void">
			</return>
			<argument index="0" name="plugin" type="EditorSpatialGizmoPlugin">
			</argument>
			<description>
			</description>
		</method>
		<method name="remove_tool_menu_item">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<description>
				Removes a menu [code]name[/code] from [b]Project &gt; Tools[/b].
			</description>
		</method>
		<method name="save_external_data" qualifiers="virtual">
			<return type="void">
			</return>
			<description>
				This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources.
			</description>
		</method>
		<method name="set_force_draw_over_forwarding_enabled">
			<return type="void">
			</return>
			<description>
			</description>
		</method>
		<method name="set_input_event_forwarding_always_enabled">
			<return type="void">
			</return>
			<description>
				Use this method if you always want to receive inputs from 3D view screen inside [method forward_spatial_gui_input]. It might be especially usable if your plugin will want to use raycast in the scene.
			</description>
		</method>
		<method name="set_state" qualifiers="virtual">
			<return type="void">
			</return>
			<argument index="0" name="state" type="Dictionary">
			</argument>
			<description>
				Restore the state saved by [method get_state].
			</description>
		</method>
		<method name="set_window_layout" qualifiers="virtual">
			<return type="void">
			</return>
			<argument index="0" name="layout" type="ConfigFile">
			</argument>
			<description>
				Restore the plugin GUI layout saved by [method get_window_layout].
			</description>
		</method>
		<method name="update_overlays" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Updates the overlays of the editor (2D/3D) viewport.
			</description>
		</method>
	</methods>
	<signals>
		<signal name="main_screen_changed">
			<argument index="0" name="screen_name" type="String">
			</argument>
			<description>
				Emitted when user changes the workspace ([b]2D[/b], [b]3D[/b], [b]Script[/b], [b]AssetLib[/b]). Also works with custom screens defined by plugins.
			</description>
		</signal>
		<signal name="resource_saved">
			<argument index="0" name="resource" type="Resource">
			</argument>
			<description>
			</description>
		</signal>
		<signal name="scene_changed">
			<argument index="0" name="scene_root" type="Node">
			</argument>
			<description>
				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 [code]null[/code].
			</description>
		</signal>
		<signal name="scene_closed">
			<argument index="0" name="filepath" type="String">
			</argument>
			<description>
				Emitted when user closes a scene. The argument is file path to a closed scene.
			</description>
		</signal>
	</signals>
	<constants>
		<constant name="CONTAINER_TOOLBAR" value="0" enum="CustomControlContainer">
		</constant>
		<constant name="CONTAINER_SPATIAL_EDITOR_MENU" value="1" enum="CustomControlContainer">
		</constant>
		<constant name="CONTAINER_SPATIAL_EDITOR_SIDE_LEFT" value="2" enum="CustomControlContainer">
		</constant>
		<constant name="CONTAINER_SPATIAL_EDITOR_SIDE_RIGHT" value="3" enum="CustomControlContainer">
		</constant>
		<constant name="CONTAINER_SPATIAL_EDITOR_BOTTOM" value="4" enum="CustomControlContainer">
		</constant>
		<constant name="CONTAINER_CANVAS_EDITOR_MENU" value="5" enum="CustomControlContainer">
		</constant>
		<constant name="CONTAINER_CANVAS_EDITOR_SIDE_LEFT" value="6" enum="CustomControlContainer">
		</constant>
		<constant name="CONTAINER_CANVAS_EDITOR_SIDE_RIGHT" value="7" enum="CustomControlContainer">
		</constant>
		<constant name="CONTAINER_CANVAS_EDITOR_BOTTOM" value="8" enum="CustomControlContainer">
		</constant>
		<constant name="CONTAINER_PROPERTY_EDITOR_BOTTOM" value="9" enum="CustomControlContainer">
		</constant>
		<constant name="CONTAINER_PROJECT_SETTING_TAB_LEFT" value="10" enum="CustomControlContainer">
		</constant>
		<constant name="CONTAINER_PROJECT_SETTING_TAB_RIGHT" value="11" enum="CustomControlContainer">
		</constant>
		<constant name="DOCK_SLOT_LEFT_UL" value="0" enum="DockSlot">
		</constant>
		<constant name="DOCK_SLOT_LEFT_BL" value="1" enum="DockSlot">
		</constant>
		<constant name="DOCK_SLOT_LEFT_UR" value="2" enum="DockSlot">
		</constant>
		<constant name="DOCK_SLOT_LEFT_BR" value="3" enum="DockSlot">
		</constant>
		<constant name="DOCK_SLOT_RIGHT_UL" value="4" enum="DockSlot">
		</constant>
		<constant name="DOCK_SLOT_RIGHT_BL" value="5" enum="DockSlot">
		</constant>
		<constant name="DOCK_SLOT_RIGHT_UR" value="6" enum="DockSlot">
		</constant>
		<constant name="DOCK_SLOT_RIGHT_BR" value="7" enum="DockSlot">
		</constant>
		<constant name="DOCK_SLOT_MAX" value="8" enum="DockSlot">
			Represents the size of the [enum DockSlot] enum.
		</constant>
	</constants>
</class>