2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 09:03:48 +08:00
<class name= "EditorPlugin" inherits= "Node" version= "4.0" >
2017-09-13 04:42:36 +08:00
<brief_description >
Used by the editor to extend its functionality.
</brief_description>
<description >
2019-06-22 07:04:47 +08:00
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.
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
2021-11-15 17:43:07 +08:00
<link title= "Editor plugins documentation index" > $DOCS_URL/tutorials/plugins/editor/index.html</link>
2017-09-13 04:42:36 +08:00
</tutorials>
<methods >
2021-05-16 05:48:59 +08:00
<method name= "_apply_changes" qualifiers= "virtual" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2017-09-13 04:42:36 +08:00
<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>
2021-05-16 05:48:59 +08:00
<method name= "_build" qualifiers= "virtual" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2018-05-28 20:53:15 +08:00
<description >
2021-02-19 20:42:22 +08:00
This method is called when the editor is about to run the project. The plugin can then perform required operations before the project runs.
2021-05-16 05:48:59 +08:00
This method must return a boolean. If this method returns [code]false[/code], the project will not run. The run is aborted immediately, so this also prevents all other plugins' [method _build] methods from running.
2018-05-28 20:53:15 +08:00
</description>
</method>
2021-05-16 05:48:59 +08:00
<method name= "_clear" qualifiers= "virtual" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2017-09-13 04:42:36 +08:00
<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>
2021-05-16 05:48:59 +08:00
<method name= "_disable_plugin" qualifiers= "virtual" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2018-12-27 18:10:09 +08:00
<description >
2019-07-22 18:37:33 +08:00
Called by the engine when the user disables the [EditorPlugin] in the Plugin tab of the project settings window.
2018-12-27 18:10:09 +08:00
</description>
</method>
2021-05-16 05:48:59 +08:00
<method name= "_edit" qualifiers= "virtual" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2021-08-22 09:52:44 +08:00
<argument index= "0" name= "object" type= "Variant" />
2017-09-13 04:42:36 +08:00
<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>
2021-05-16 05:48:59 +08:00
<method name= "_enable_plugin" qualifiers= "virtual" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2018-12-27 18:10:09 +08:00
<description >
2019-07-22 18:37:33 +08:00
Called by the engine when the user enables the [EditorPlugin] in the Plugin tab of the project settings window.
2018-12-27 18:10:09 +08:00
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_forward_3d_draw_over_viewport" qualifiers= "virtual" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2021-08-22 09:52:44 +08:00
<argument index= "0" name= "viewport_control" type= "Control" />
2017-09-13 04:42:36 +08:00
<description >
2021-08-22 09:52:44 +08:00
Called by the engine when the 3D editor's viewport is updated. Use the [code]overlay[/code] [Control] for drawing. You can update the viewport manually by calling [method update_overlays].
2020-11-10 17:12:49 +08:00
[codeblocks]
[gdscript]
2021-08-23 01:46:17 +08:00
func _forward_3d_draw_over_viewport(overlay):
2020-11-06 20:24:51 +08:00
# Draw a circle at cursor position.
2021-08-22 09:52:44 +08:00
overlay.draw_circle(overlay.get_local_mouse_position(), 64)
2020-11-06 20:24:51 +08:00
2021-08-23 01:46:17 +08:00
func _forward_3d_gui_input(camera, event):
2020-11-06 20:24:51 +08:00
if event is InputEventMouseMotion:
# Redraw viewport when cursor is moved.
update_overlays()
2020-11-10 17:12:49 +08:00
return true
return false
[/gdscript]
[csharp]
2021-08-23 01:46:17 +08:00
public override void _Forward3dDrawOverViewport(Godot.Control overlay)
2020-11-10 17:12:49 +08:00
{
// Draw a circle at cursor position.
overlay.DrawCircle(overlay.GetLocalMousePosition(), 64, Colors.White);
}
2021-08-23 01:46:17 +08:00
public override bool _Forward3dGuiInput(Godot.Camera3D camera, InputEvent @event)
2020-11-10 17:12:49 +08:00
{
if (@event is InputEventMouseMotion)
{
// Redraw viewport when cursor is moved.
UpdateOverlays();
return true;
}
return false;
[/csharp]
[/codeblocks]
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_forward_3d_force_draw_over_viewport" qualifiers= "virtual" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2021-08-22 09:52:44 +08:00
<argument index= "0" name= "viewport_control" type= "Control" />
2017-11-28 06:37:47 +08:00
<description >
2021-08-22 09:52:44 +08:00
This method is the same as [method _forward_3d_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else.
2020-11-06 20:24:51 +08:00
You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled].
2017-11-28 06:37:47 +08:00
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_forward_3d_gui_input" qualifiers= "virtual" >
2021-02-04 16:20:26 +08:00
<return type= "int" />
2021-08-22 09:52:44 +08:00
<argument index= "0" name= "viewport_camera" type= "Camera3D" />
<argument index= "1" name= "event" type= "InputEvent" />
2017-09-13 04:42:36 +08:00
<description >
2021-08-22 09:52:44 +08:00
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:
2020-09-13 20:45:36 +08:00
[codeblocks]
[gdscript]
2021-08-22 09:52:44 +08:00
# Prevents the InputEvent to reach other Editor classes.
2021-08-23 01:46:17 +08:00
func _forward_3d_gui_input(camera, event):
2021-02-04 16:20:26 +08:00
return EditorPlugin.AFTER_GUI_INPUT_STOP
2020-09-13 20:45:36 +08:00
[/gdscript]
[csharp]
2021-08-22 09:52:44 +08:00
// Prevents the InputEvent to reach other Editor classes.
2021-08-23 01:46:17 +08:00
public override bool _Forward3dGuiInput(Camera3D camera, InputEvent @event)
2020-09-13 20:45:36 +08:00
{
2021-02-04 16:20:26 +08:00
return EditorPlugin.AFTER_GUI_INPUT_STOP;
2020-09-13 20:45:36 +08:00
}
[/csharp]
[/codeblocks]
2019-07-22 18:37:33 +08:00
Must [code]return false[/code] in order to forward the [InputEvent] to other Editor classes. Example:
2020-09-13 20:45:36 +08:00
[codeblocks]
[gdscript]
# Consumes InputEventMouseMotion and forwards other InputEvent types.
2021-08-23 01:46:17 +08:00
func _forward_3d_gui_input(camera, event):
2020-09-13 20:45:36 +08:00
return event is InputEventMouseMotion
[/gdscript]
[csharp]
// Consumes InputEventMouseMotion and forwards other InputEvent types.
2021-08-23 01:46:17 +08:00
public override bool _Forward3dGuiInput(Camera3D camera, InputEvent @event)
2020-09-13 20:45:36 +08:00
{
return @event is InputEventMouseMotion;
}
[/csharp]
[/codeblocks]
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_forward_canvas_draw_over_viewport" qualifiers= "virtual" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2021-08-22 09:52:44 +08:00
<argument index= "0" name= "viewport_control" type= "Control" />
2020-11-06 20:43:57 +08:00
<description >
2021-08-22 09:52:44 +08:00
Called by the engine when the 2D editor's viewport is updated. Use the [code]overlay[/code] [Control] for drawing. You can update the viewport manually by calling [method update_overlays].
2020-11-06 20:43:57 +08:00
[codeblocks]
[gdscript]
2021-08-22 09:52:44 +08:00
func _forward_canvas_draw_over_viewport(overlay):
2020-11-06 20:43:57 +08:00
# Draw a circle at cursor position.
2021-08-22 09:52:44 +08:00
overlay.draw_circle(overlay.get_local_mouse_position(), 64, Color.white)
2020-11-06 20:43:57 +08:00
2021-08-22 09:52:44 +08:00
func _forward_canvas_gui_input(event):
2020-11-06 20:43:57 +08:00
if event is InputEventMouseMotion:
# Redraw viewport when cursor is moved.
update_overlays()
return true
return false
[/gdscript]
[csharp]
2021-08-22 09:52:44 +08:00
public override void ForwardCanvasDrawOverViewport(Godot.Control overlay)
2020-11-06 20:43:57 +08:00
{
// Draw a circle at cursor position.
overlay.DrawCircle(overlay.GetLocalMousePosition(), 64, Colors.White);
}
2021-08-22 09:52:44 +08:00
public override bool ForwardCanvasGuiInput(InputEvent @event)
2020-11-06 20:43:57 +08:00
{
if (@event is InputEventMouseMotion)
{
// Redraw viewport when cursor is moved.
UpdateOverlays();
return true;
}
return false;
[/csharp]
[/codeblocks]
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_forward_canvas_force_draw_over_viewport" qualifiers= "virtual" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2021-08-22 09:52:44 +08:00
<argument index= "0" name= "viewport_control" type= "Control" />
2020-11-06 20:43:57 +08:00
<description >
2021-08-22 09:52:44 +08:00
This method is the same as [method _forward_canvas_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else.
2020-11-06 20:43:57 +08:00
You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled].
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_forward_canvas_gui_input" qualifiers= "virtual" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2021-08-22 09:52:44 +08:00
<argument index= "0" name= "event" type= "InputEvent" />
2017-09-13 04:42:36 +08:00
<description >
2021-08-22 09:52:44 +08:00
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:
2020-09-13 20:45:36 +08:00
[codeblocks]
[gdscript]
2021-02-04 16:20:26 +08:00
# Prevents the InputEvent to reach other Editor classes.
2021-08-22 09:52:44 +08:00
func _forward_canvas_gui_input(event):
2020-09-13 20:45:36 +08:00
return true
[/gdscript]
[csharp]
2021-02-04 16:20:26 +08:00
// Prevents the InputEvent to reach other Editor classes.
2021-08-22 09:52:44 +08:00
public override bool ForwardCanvasGuiInput(InputEvent @event)
2020-09-13 20:45:36 +08:00
{
return true;
}
[/csharp]
[/codeblocks]
2019-07-22 18:37:33 +08:00
Must [code]return false[/code] in order to forward the [InputEvent] to other Editor classes. Example:
2020-09-13 20:45:36 +08:00
[codeblocks]
[gdscript]
# Consumes InputEventMouseMotion and forwards other InputEvent types.
2021-08-22 09:52:44 +08:00
func _forward_canvas_gui_input(event):
2021-02-04 16:20:26 +08:00
if (event is InputEventMouseMotion):
return true
return false
2020-09-13 20:45:36 +08:00
[/gdscript]
[csharp]
// Consumes InputEventMouseMotion and forwards other InputEvent types.
2021-08-22 09:52:44 +08:00
public override bool ForwardCanvasGuiInput(InputEvent @event)
2020-09-13 20:45:36 +08:00
{
2021-02-04 16:20:26 +08:00
if (@event is InputEventMouseMotion) {
return true;
}
return false
2020-09-13 20:45:36 +08:00
}
[/csharp]
[/codeblocks]
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_get_breakpoints" qualifiers= "virtual const" >
2021-07-30 21:28:05 +08:00
<return type= "PackedStringArray" />
2017-09-13 04:42:36 +08:00
<description >
2019-06-22 07:04:47 +08:00
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].
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_get_plugin_icon" qualifiers= "virtual const" >
2021-07-30 21:28:05 +08:00
<return type= "Texture2D" />
2017-12-10 07:43:30 +08:00
<description >
2020-03-03 09:53:41 +08:00
Override this method in your plugin to return a [Texture2D] in order to give it an icon.
For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons.
Ideally, the plugin icon should be white with a transparent background and 16x16 pixels in size.
2020-09-13 20:45:36 +08:00
[codeblocks]
[gdscript]
2021-05-16 05:48:59 +08:00
func _get_plugin_icon():
2020-03-03 09:53:41 +08:00
# You can use a custom icon:
return preload("res://addons/my_plugin/my_plugin_icon.svg")
# Or use a built-in icon:
return get_editor_interface().get_base_control().get_icon("Node", "EditorIcons")
2020-09-13 20:45:36 +08:00
[/gdscript]
[csharp]
public override Texture2D GetPluginIcon()
{
// You can use a custom icon:
return ResourceLoader.Load< Texture2D> ("res://addons/my_plugin/my_plugin_icon.svg");
// Or use a built-in icon:
return GetEditorInterface().GetBaseControl().GetIcon("Node", "EditorIcons");
}
[/csharp]
[/codeblocks]
2017-12-10 07:43:30 +08:00
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_get_plugin_name" qualifiers= "virtual const" >
2021-07-30 21:28:05 +08:00
<return type= "String" />
2017-09-13 04:42:36 +08:00
<description >
2020-03-03 09:53:41 +08:00
Override this method in your plugin to provide the name of the plugin when displayed in the Godot editor.
For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons.
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_get_state" qualifiers= "virtual const" >
2021-07-30 21:28:05 +08:00
<return type= "Dictionary" />
2017-09-13 04:42:36 +08:00
<description >
2019-06-22 07:04:47 +08:00
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).
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-05-16 05:48:59 +08:00
<method name= "_get_window_layout" qualifiers= "virtual" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2021-08-22 09:52:44 +08:00
<argument index= "0" name= "configuration" type= "ConfigFile" />
2017-09-13 04:42:36 +08:00
<description >
2019-06-22 07:04:47 +08:00
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).
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_handles" qualifiers= "virtual const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2021-08-22 09:52:44 +08:00
<argument index= "0" name= "object" type= "Variant" />
2017-09-13 04:42:36 +08:00
<description >
2021-08-22 09:52:44 +08:00
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_3d_gui_input] these will be called too.
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_has_main_screen" qualifiers= "virtual const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2017-09-13 04:42:36 +08:00
<description >
2019-06-22 07:04:47 +08:00
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]).
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-05-16 05:48:59 +08:00
<method name= "_make_visible" qualifiers= "virtual" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "visible" type= "bool" />
2017-09-13 04:42:36 +08:00
<description >
2021-05-16 05:48:59 +08:00
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.
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-05-16 05:48:59 +08:00
<method name= "_save_external_data" qualifiers= "virtual" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2021-05-16 05:48:59 +08:00
<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_state" qualifiers= "virtual" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "state" type= "Dictionary" />
2017-09-13 04:42:36 +08:00
<description >
2021-05-16 05:48:59 +08:00
Restore the state saved by [method _get_state].
2017-09-13 04:42:36 +08:00
</description>
</method>
2021-06-13 07:32:28 +08:00
<method name= "_set_window_layout" qualifiers= "virtual" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2021-08-22 09:52:44 +08:00
<argument index= "0" name= "configuration" type= "ConfigFile" />
2021-06-13 07:32:28 +08:00
<description >
Restore the plugin GUI layout saved by [method _get_window_layout].
</description>
</method>
2021-05-16 05:48:59 +08:00
<method name= "add_autoload_singleton" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "name" type= "String" />
<argument index= "1" name= "path" type= "String" />
2021-05-16 05:48:59 +08:00
<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" >
2021-07-30 21:28:05 +08:00
<return type= "Button" />
<argument index= "0" name= "control" type= "Control" />
<argument index= "1" name= "title" type= "String" />
2021-05-16 05:48:59 +08:00
<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" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "container" type= "int" enum= "EditorPlugin.CustomControlContainer" />
<argument index= "1" name= "control" type= "Control" />
2021-05-16 05:48:59 +08:00
<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" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "slot" type= "int" enum= "EditorPlugin.DockSlot" />
<argument index= "1" name= "control" type= "Control" />
2021-05-16 05:48:59 +08:00
<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" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "type" type= "String" />
<argument index= "1" name= "base" type= "String" />
<argument index= "2" name= "script" type= "Script" />
<argument index= "3" name= "icon" type= "Texture2D" />
2021-05-16 05:48:59 +08:00
<description >
Adds a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed.
2021-07-23 22:24:57 +08:00
When a given node or resource is selected, the base type will be instantiated (e.g. "Node3D", "Control", "Resource"), then the script will be loaded and set to this object.
2021-05-16 05:48:59 +08:00
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_debugger_plugin" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "script" type= "Script" />
2021-05-16 05:48:59 +08:00
<description >
Adds a [Script] as debugger plugin to the Debugger. The script must extend [EditorDebuggerPlugin].
</description>
</method>
<method name= "add_export_plugin" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "plugin" type= "EditorExportPlugin" />
2021-05-16 05:48:59 +08:00
<description >
Registers a new [EditorExportPlugin]. Export plugins are used to perform tasks when the project is being exported.
See [method add_inspector_plugin] for an example of how to register a plugin.
</description>
</method>
<method name= "add_import_plugin" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "importer" type= "EditorImportPlugin" />
2022-02-07 16:38:42 +08:00
<argument index= "1" name= "first_priority" type= "bool" default= "false" />
2021-05-16 05:48:59 +08:00
<description >
Registers a new [EditorImportPlugin]. Import plugins are used to import custom and unsupported assets as a custom [Resource] type.
2022-02-07 16:38:42 +08:00
If [code]first_priority[/code] is [code]true[/code], the new import plugin is inserted first in the list and takes precedence over pre-existing plugins.
2021-10-15 01:34:27 +08:00
[b]Note:[/b] If you want to import custom 3D asset formats use [method add_scene_format_importer_plugin] instead.
2021-05-16 05:48:59 +08:00
See [method add_inspector_plugin] for an example of how to register a plugin.
</description>
</method>
<method name= "add_inspector_plugin" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "plugin" type= "EditorInspectorPlugin" />
2021-05-16 05:48:59 +08:00
<description >
Registers a new [EditorInspectorPlugin]. Inspector plugins are used to extend [EditorInspector] and provide custom configuration tools for your object's properties.
[b]Note:[/b] Always use [method remove_inspector_plugin] to remove the registered [EditorInspectorPlugin] when your [EditorPlugin] is disabled to prevent leaks and an unexpected behavior.
[codeblocks]
[gdscript]
const MyInspectorPlugin = preload("res://addons/your_addon/path/to/your/script.gd")
var inspector_plugin = MyInspectorPlugin.new()
func _enter_tree():
add_inspector_plugin(inspector_plugin)
func _exit_tree():
remove_inspector_plugin(inspector_plugin)
[/gdscript]
[/codeblocks]
</description>
</method>
2021-10-15 01:34:27 +08:00
<method name= "add_scene_format_importer_plugin" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2021-10-15 01:34:27 +08:00
<argument index= "0" name= "scene_format_importer" type= "EditorSceneFormatImporter" />
2022-02-07 16:38:42 +08:00
<argument index= "1" name= "first_priority" type= "bool" default= "false" />
2021-05-16 05:48:59 +08:00
<description >
2021-10-15 01:34:27 +08:00
Registers a new [EditorSceneFormatImporter]. Scene importers are used to import custom 3D asset formats as scenes.
2022-02-07 16:38:42 +08:00
If [code]first_priority[/code] is [code]true[/code], the new import plugin is inserted first in the list and takes precedence over pre-existing plugins.
2021-10-15 01:34:27 +08:00
</description>
</method>
<method name= "add_scene_post_import_plugin" >
<return type= "void" />
<argument index= "0" name= "scene_import_plugin" type= "EditorScenePostImportPlugin" />
2022-02-07 16:38:42 +08:00
<argument index= "1" name= "first_priority" type= "bool" default= "false" />
2021-10-15 01:34:27 +08:00
<description >
Add a [EditorScenePostImportPlugin]. These plugins allow customizing the import process of 3D assets by adding new options to the import dialogs.
2022-02-07 16:38:42 +08:00
If [code]first_priority[/code] is [code]true[/code], the new import plugin is inserted first in the list and takes precedence over pre-existing plugins.
2021-05-16 05:48:59 +08:00
</description>
</method>
<method name= "add_spatial_gizmo_plugin" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "plugin" type= "EditorNode3DGizmoPlugin" />
2021-05-16 05:48:59 +08:00
<description >
Registers a new [EditorNode3DGizmoPlugin]. Gizmo plugins are used to add custom gizmos to the 3D preview viewport for a [Node3D].
See [method add_inspector_plugin] for an example of how to register a plugin.
</description>
</method>
<method name= "add_tool_menu_item" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "name" type= "String" />
<argument index= "1" name= "callable" type= "Callable" />
2021-05-16 05:48:59 +08:00
<description >
Adds a custom menu item to [b]Project > Tools[/b] named [code]name[/code]. When clicked, the provided [code]callable[/code] will be called.
</description>
</method>
<method name= "add_tool_submenu_item" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "name" type= "String" />
2022-01-28 22:06:54 +08:00
<argument index= "1" name= "submenu" type= "PopupMenu" />
2021-05-16 05:48:59 +08:00
<description >
2022-01-28 22:06:54 +08:00
Adds a custom [PopupMenu] submenu under [b]Project > Tools > [/b] [code]name[/code]. Use [code]remove_tool_menu_item(name)[/code] on plugin clean up to remove the menu.
2021-05-16 05:48:59 +08:00
</description>
</method>
<method name= "add_translation_parser_plugin" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "parser" type= "EditorTranslationParserPlugin" />
2021-05-16 05:48:59 +08:00
<description >
Registers a custom translation parser plugin for extracting translatable strings from custom files.
</description>
</method>
<method name= "add_undo_redo_inspector_hook_callback" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "callable" type= "Callable" />
2021-05-16 05:48:59 +08:00
<description >
Hooks a callback into the undo/redo action creation when a property is modified in the inspector. This allows, for example, to save other properties that may be lost when a given property is modified.
The callback should have 4 arguments: [Object] [code]undo_redo[/code], [Object] [code]modified_object[/code], [String] [code]property[/code] and [Variant] [code]new_value[/code]. They are, respectively, the [UndoRedo] object used by the inspector, the currently modified object, the name of the modified property and the new value the property is about to take.
</description>
</method>
<method name= "get_editor_interface" >
2021-07-30 21:28:05 +08:00
<return type= "EditorInterface" />
2021-05-16 05:48:59 +08:00
<description >
Returns the [EditorInterface] object that gives you control over Godot editor's window and its functionalities.
</description>
</method>
<method name= "get_script_create_dialog" >
2021-07-30 21:28:05 +08:00
<return type= "ScriptCreateDialog" />
2021-05-16 05:48:59 +08:00
<description >
Gets the Editor's dialogue used for making scripts.
[b]Note:[/b] Users can configure it before use.
2021-10-11 03:28:56 +08:00
[b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash.
2021-05-16 05:48:59 +08:00
</description>
</method>
<method name= "get_undo_redo" >
2021-07-30 21:28:05 +08:00
<return type= "UndoRedo" />
2021-05-16 05:48:59 +08:00
<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= "hide_bottom_panel" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2021-05-16 05:48:59 +08:00
<description >
2021-07-06 19:22:53 +08:00
Minimizes the bottom panel.
2021-05-16 05:48:59 +08:00
</description>
</method>
<method name= "make_bottom_panel_item_visible" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "item" type= "Control" />
2017-09-13 04:42:36 +08:00
<description >
2021-07-06 19:22:53 +08:00
Makes a specific item in the bottom panel visible.
2017-09-13 04:42:36 +08:00
</description>
</method>
2020-11-04 22:38:26 +08:00
<method name= "queue_save_layout" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2017-09-13 04:42:36 +08:00
<description >
Queue save the project's editor layout.
</description>
</method>
2018-02-25 14:19:42 +08:00
<method name= "remove_autoload_singleton" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "name" type= "String" />
2018-02-25 14:19:42 +08:00
<description >
2019-06-22 07:04:47 +08:00
Removes an Autoload [code]name[/code] from the list.
2018-02-25 14:19:42 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
<method name= "remove_control_from_bottom_panel" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "control" type= "Control" />
2017-09-13 04:42:36 +08:00
<description >
2019-07-22 18:37:33 +08:00
Removes the control from the bottom panel. You have to manually [method Node.queue_free] the control.
2017-09-13 04:42:36 +08:00
</description>
</method>
2018-02-14 05:21:19 +08:00
<method name= "remove_control_from_container" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "container" type= "int" enum= "EditorPlugin.CustomControlContainer" />
<argument index= "1" name= "control" type= "Control" />
2018-02-14 05:21:19 +08:00
<description >
2019-07-22 18:37:33 +08:00
Removes the control from the specified container. You have to manually [method Node.queue_free] the control.
2018-02-14 05:21:19 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
<method name= "remove_control_from_docks" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "control" type= "Control" />
2017-09-13 04:42:36 +08:00
<description >
2019-07-22 18:37:33 +08:00
Removes the control from the dock. You have to manually [method Node.queue_free] the control.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "remove_custom_type" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "type" type= "String" />
2017-09-13 04:42:36 +08:00
<description >
2019-06-22 07:04:47 +08:00
Removes a custom type added by [method add_custom_type].
2017-09-13 04:42:36 +08:00
</description>
</method>
2020-05-18 22:55:49 +08:00
<method name= "remove_debugger_plugin" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "script" type= "Script" />
2020-05-18 22:55:49 +08:00
<description >
2021-03-18 19:04:28 +08:00
Removes the debugger plugin with given script from the Debugger.
2020-05-18 22:55:49 +08:00
</description>
</method>
2017-09-16 07:46:14 +08:00
<method name= "remove_export_plugin" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "plugin" type= "EditorExportPlugin" />
2017-09-16 07:46:14 +08:00
<description >
2021-04-16 01:23:27 +08:00
Removes an export plugin registered by [method add_export_plugin].
2017-09-16 07:46:14 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
<method name= "remove_import_plugin" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "importer" type= "EditorImportPlugin" />
2017-09-13 04:42:36 +08:00
<description >
2021-04-16 01:23:27 +08:00
Removes an import plugin registered by [method add_import_plugin].
2017-09-13 04:42:36 +08:00
</description>
</method>
2018-05-28 20:53:15 +08:00
<method name= "remove_inspector_plugin" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "plugin" type= "EditorInspectorPlugin" />
2018-05-28 20:53:15 +08:00
<description >
2021-04-16 01:23:27 +08:00
Removes an inspector plugin registered by [method add_import_plugin]
2018-05-28 20:53:15 +08:00
</description>
</method>
2021-10-15 01:34:27 +08:00
<method name= "remove_scene_format_importer_plugin" >
<return type= "void" />
<argument index= "0" name= "scene_format_importer" type= "EditorSceneFormatImporter" />
<description >
Removes a scene format importer registered by [method add_scene_format_importer_plugin].
</description>
</method>
<method name= "remove_scene_post_import_plugin" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2021-10-15 01:34:27 +08:00
<argument index= "0" name= "scene_import_plugin" type= "EditorScenePostImportPlugin" />
2017-12-10 07:43:30 +08:00
<description >
2021-10-15 01:34:27 +08:00
Remove the [EditorScenePostImportPlugin], added with [method add_scene_post_import_plugin].
2017-12-10 07:43:30 +08:00
</description>
</method>
2018-10-29 18:30:28 +08:00
<method name= "remove_spatial_gizmo_plugin" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "plugin" type= "EditorNode3DGizmoPlugin" />
2018-10-29 18:30:28 +08:00
<description >
2021-04-16 01:23:27 +08:00
Removes a gizmo plugin registered by [method add_spatial_gizmo_plugin].
2018-10-29 18:30:28 +08:00
</description>
</method>
2018-04-10 16:12:42 +08:00
<method name= "remove_tool_menu_item" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "name" type= "String" />
2018-04-10 16:12:42 +08:00
<description >
2019-06-22 07:04:47 +08:00
Removes a menu [code]name[/code] from [b]Project > Tools[/b].
2018-04-10 16:12:42 +08:00
</description>
</method>
2020-06-23 19:48:59 +08:00
<method name= "remove_translation_parser_plugin" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "parser" type= "EditorTranslationParserPlugin" />
2020-06-23 19:48:59 +08:00
<description >
2021-04-16 01:23:27 +08:00
Removes a custom translation parser plugin registered by [method add_translation_parser_plugin].
2020-06-23 19:48:59 +08:00
</description>
</method>
2021-04-28 23:39:57 +08:00
<method name= "remove_undo_redo_inspector_hook_callback" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
<argument index= "0" name= "callable" type= "Callable" />
2021-04-28 23:39:57 +08:00
<description >
Removes a callback previsously added by [method add_undo_redo_inspector_hook_callback].
</description>
</method>
2017-11-28 06:37:47 +08:00
<method name= "set_force_draw_over_forwarding_enabled" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2017-11-28 06:37:47 +08:00
<description >
2021-08-22 09:52:44 +08:00
Enables calling of [method _forward_canvas_force_draw_over_viewport] for the 2D editor and [method _forward_3d_force_draw_over_viewport] for the 3D editor when their viewports are updated. You need to call this method only once and it will work permanently for this plugin.
2017-11-28 06:37:47 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
<method name= "set_input_event_forwarding_always_enabled" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2017-09-13 04:42:36 +08:00
<description >
2021-08-22 09:52:44 +08:00
Use this method if you always want to receive inputs from 3D view screen inside [method _forward_3d_gui_input]. It might be especially usable if your plugin will want to use raycast in the scene.
2017-09-13 04:42:36 +08:00
</description>
</method>
2017-11-28 06:37:47 +08:00
<method name= "update_overlays" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "int" />
2017-09-13 04:42:36 +08:00
<description >
2021-08-22 09:52:44 +08:00
Updates the overlays of the 2D and 3D editor viewport. Causes methods [method _forward_canvas_draw_over_viewport], [method _forward_canvas_force_draw_over_viewport], [method _forward_3d_draw_over_viewport] and [method _forward_3d_force_draw_over_viewport] to be called.
2017-09-13 04:42:36 +08:00
</description>
</method>
</methods>
<signals >
<signal name= "main_screen_changed" >
2021-07-30 21:28:05 +08:00
<argument index= "0" name= "screen_name" type= "String" />
2017-09-13 04:42:36 +08:00
<description >
2019-06-22 07:04:47 +08:00
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.
2017-09-13 04:42:36 +08:00
</description>
</signal>
2021-02-19 20:35:31 +08:00
<signal name= "project_settings_changed" >
<description >
</description>
</signal>
2018-05-12 15:38:00 +08:00
<signal name= "resource_saved" >
2021-07-30 21:28:05 +08:00
<argument index= "0" name= "resource" type= "Resource" />
2018-05-12 15:38:00 +08:00
<description >
</description>
</signal>
2017-09-13 04:42:36 +08:00
<signal name= "scene_changed" >
2021-07-30 21:28:05 +08:00
<argument index= "0" name= "scene_root" type= "Node" />
2017-09-13 04:42:36 +08:00
<description >
2019-06-22 07:04:47 +08:00
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].
2017-09-13 04:42:36 +08:00
</description>
</signal>
<signal name= "scene_closed" >
2021-07-30 21:28:05 +08:00
<argument index= "0" name= "filepath" type= "String" />
2017-09-13 04:42:36 +08:00
<description >
2018-09-17 17:14:10 +08:00
Emitted when user closes a scene. The argument is file path to a closed scene.
2017-09-13 04:42:36 +08:00
</description>
</signal>
</signals>
<constants >
2017-11-25 06:16:30 +08:00
<constant name= "CONTAINER_TOOLBAR" value= "0" enum= "CustomControlContainer" >
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "CONTAINER_SPATIAL_EDITOR_MENU" value= "1" enum= "CustomControlContainer" >
2017-09-13 04:42:36 +08:00
</constant>
2018-08-30 04:25:11 +08:00
<constant name= "CONTAINER_SPATIAL_EDITOR_SIDE_LEFT" value= "2" enum= "CustomControlContainer" >
2017-09-13 04:42:36 +08:00
</constant>
2018-08-30 04:25:11 +08:00
<constant name= "CONTAINER_SPATIAL_EDITOR_SIDE_RIGHT" value= "3" enum= "CustomControlContainer" >
2017-09-13 04:42:36 +08:00
</constant>
2018-08-30 04:25:11 +08:00
<constant name= "CONTAINER_SPATIAL_EDITOR_BOTTOM" value= "4" enum= "CustomControlContainer" >
2017-09-13 04:42:36 +08:00
</constant>
2018-08-30 04:25:11 +08:00
<constant name= "CONTAINER_CANVAS_EDITOR_MENU" value= "5" enum= "CustomControlContainer" >
2017-09-13 04:42:36 +08:00
</constant>
2018-08-30 04:25:11 +08:00
<constant name= "CONTAINER_CANVAS_EDITOR_SIDE_LEFT" value= "6" enum= "CustomControlContainer" >
2017-10-22 18:56:11 +08:00
</constant>
2018-08-30 04:25:11 +08:00
<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" >
2017-09-13 04:42:36 +08:00
</constant>
2019-06-01 18:34:29 +08:00
<constant name= "CONTAINER_PROJECT_SETTING_TAB_LEFT" value= "10" enum= "CustomControlContainer" >
</constant>
<constant name= "CONTAINER_PROJECT_SETTING_TAB_RIGHT" value= "11" enum= "CustomControlContainer" >
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "DOCK_SLOT_LEFT_UL" value= "0" enum= "DockSlot" >
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "DOCK_SLOT_LEFT_BL" value= "1" enum= "DockSlot" >
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "DOCK_SLOT_LEFT_UR" value= "2" enum= "DockSlot" >
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "DOCK_SLOT_LEFT_BR" value= "3" enum= "DockSlot" >
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "DOCK_SLOT_RIGHT_UL" value= "4" enum= "DockSlot" >
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "DOCK_SLOT_RIGHT_BL" value= "5" enum= "DockSlot" >
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "DOCK_SLOT_RIGHT_UR" value= "6" enum= "DockSlot" >
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "DOCK_SLOT_RIGHT_BR" value= "7" enum= "DockSlot" >
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "DOCK_SLOT_MAX" value= "8" enum= "DockSlot" >
2019-06-27 17:10:53 +08:00
Represents the size of the [enum DockSlot] enum.
2017-09-13 04:42:36 +08:00
</constant>
</constants>
</class>
