EditorPlugin
Inherited by: GridMapEditorPlugin
Used by the editor to extend its functionality.
Description
Section titled “Description”Plugins are used by the editor to extend functionality. The most common types of plugins are those which edit a given actor 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. CONTAINER_SPATIAL_EDITOR_SIDE_LEFT). These APIs assume left-to-right layout, and would be backwards when using right-to-left layout. These names are kept for compatibility reasons.
Methods
Section titled “Methods”Signals
Section titled “Signals”main_screen_changed
Section titled “main_screen_changed”main_screen_changed(screen_name: String)Emitted when user changes the workspace (2D, 3D, Script, Game). Also works with custom screens defined by plugins.
project_settings_changed
Section titled “project_settings_changed”project_settings_changed()Emitted when any project setting has changed.
resource_saved
Section titled “resource_saved”resource_saved(resource: Resource)Emitted when the given resource was saved on disc. See also scene_saved.
scene_changed
Section titled “scene_changed”scene_changed(scene_root: Actor)Emitted when the scene is changed in the editor. The argument will return the root actor of the scene that has just become active. If this scene is new and empty, the argument will be null.
scene_closed
Section titled “scene_closed”scene_closed(filepath: String)Emitted when user closes a scene. The argument is a file path to the closed scene.
scene_saved
Section titled “scene_saved”scene_saved(filepath: String)Emitted when a scene was saved on disc. The argument is a file path to the saved scene. See also resource_saved.
Enumerations and constants
Section titled “Enumerations and constants”enum CustomControlContainer
Section titled “enum CustomControlContainer”- CONTAINER_TOOLBAR =
0— Main editor toolbar, next to play buttons.
- CONTAINER_SPATIAL_EDITOR_MENU =
1— The toolbar that appears when 3D editor is active.
- CONTAINER_SPATIAL_EDITOR_SIDE_LEFT =
2— Left sidebar of the 3D editor.
- CONTAINER_SPATIAL_EDITOR_SIDE_RIGHT =
3— Right sidebar of the 3D editor.
- CONTAINER_SPATIAL_EDITOR_BOTTOM =
4— Bottom panel of the 3D editor.
- CONTAINER_CANVAS_EDITOR_MENU =
5— The toolbar that appears when 2D editor is active.
- CONTAINER_CANVAS_EDITOR_SIDE_LEFT =
6— Left sidebar of the 2D editor.
- CONTAINER_CANVAS_EDITOR_SIDE_RIGHT =
7— Right sidebar of the 2D editor.
- CONTAINER_CANVAS_EDITOR_BOTTOM =
8— Bottom panel of the 2D editor.
- CONTAINER_INSPECTOR_BOTTOM =
9— Bottom section of the inspector.
- CONTAINER_PROJECT_SETTING_TAB_LEFT =
10— Tab of Project Settings dialog, to the left of other tabs.
- CONTAINER_PROJECT_SETTING_TAB_RIGHT =
11— Tab of Project Settings dialog, to the right of other tabs.
enum AfterGUIInput
Section titled “enum AfterGUIInput”- AFTER_GUI_INPUT_PASS =
0— Forwards the InputEvent to other EditorPlugins.
- AFTER_GUI_INPUT_STOP =
1— Prevents the InputEvent from reaching other Editor classes.
- AFTER_GUI_INPUT_CUSTOM =
2— Pass the InputEvent to other editor plugins except the main Spatial3D one. This can be used to prevent actor selection changes and work with sub-gizmos instead.
Method descriptions
Section titled “Method descriptions”_apply_changes
Section titled “_apply_changes”void _apply_changes() virtual
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.
_build
Section titled “_build”bool _build() virtual
This method is called when the editor is about to run the project. The plugin can then perform required operations before the project runs.
This method must return a boolean. If this method returns false, the project will not run. The run is aborted immediately, so this also prevents all other plugins’ _build() methods from running.
_clear
Section titled “_clear”void _clear() virtual
Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing actor, or an actor from the wrong scene.
_disable_plugin
Section titled “_disable_plugin”void _disable_plugin() virtual
Called by the engine when the user disables the EditorPlugin in the Plugin tab of the project settings window.
void _edit(object: Object) virtual
This function is used for plugins that edit specific object types (actors or resources). It requests the editor to edit the given object.
object can be null if the plugin was editing an object, but there is no longer any selected object handled by this plugin. It can be used to cleanup editing state.
_enable_plugin
Section titled “_enable_plugin”void _enable_plugin() virtual
Called by the engine when the user enables the EditorPlugin in the Plugin tab of the project settings window.
_forward_3d_draw_over_viewport
Section titled “_forward_3d_draw_over_viewport”void _forward_3d_draw_over_viewport(viewport_control: Control) virtual
Called by the engine when the 3D editor’s viewport is updated. viewport_control is an overlay on top of the viewport and it can be used for drawing. You can update the viewport manually by calling update_overlays().
use actor::MyPlugin as plugin : EditorPlugin
fn _forward_3d_draw_over_viewport(overlay: Control) void { # Draw a circle at the cursor's position. overlay.draw_circle(overlay.get_local_mouse_position(), 64, Color.WHITE)}
fn _forward_3d_gui_input(camera: Camera3D, event: InputEvent) int { if event is InputEventMouseMotion { # Redraw the viewport when the cursor is moved. plugin.update_overlays() return EditorPlugin.AFTER_GUI_INPUT_STOP } return EditorPlugin.AFTER_GUI_INPUT_PASS}_forward_3d_force_draw_over_viewport
Section titled “_forward_3d_force_draw_over_viewport”void _forward_3d_force_draw_over_viewport(viewport_control: Control) virtual
This method is the same as _forward_3d_draw_over_viewport(), except it draws on top of everything. Useful when you need an extra layer that shows over anything else.
You need to enable calling of this method by using set_force_draw_over_forwarding_enabled().
_forward_3d_gui_input
Section titled “_forward_3d_gui_input”int _forward_3d_gui_input(viewport_camera: Camera3D, event: InputEvent) virtual
Called when there is a root actor in the current edited scene, _handles() is implemented, and an InputEvent happens in the 3D viewport. The return value decides whether the InputEvent is consumed or forwarded to other EditorPlugins. See AfterGUIInput for options.
# Prevents the InputEvent from reaching other Editor classes.fn _forward_3d_gui_input(camera: Camera3D, event: InputEvent) int { return EditorPlugin.AFTER_GUI_INPUT_STOP}This method must return AFTER_GUI_INPUT_PASS in order to forward the InputEvent to other Editor classes.
# Consumes InputEventMouseMotion and forwards other InputEvent types.fn _forward_3d_gui_input(camera: Camera3D, event: InputEvent) int { return EditorPlugin.AFTER_GUI_INPUT_STOP if event is InputEventMouseMotion else EditorPlugin.AFTER_GUI_INPUT_PASS}_forward_canvas_draw_over_viewport
Section titled “_forward_canvas_draw_over_viewport”void _forward_canvas_draw_over_viewport(viewport_control: Control) virtual
Called by the engine when the 2D editor’s viewport is updated. viewport_control is an overlay on top of the viewport and it can be used for drawing. You can update the viewport manually by calling update_overlays().
use actor::MyPlugin as plugin : EditorPlugin
fn _forward_canvas_draw_over_viewport(overlay: Control) void { # Draw a circle at the cursor's position. overlay.draw_circle(overlay.get_local_mouse_position(), 64, Color.WHITE)}
fn _forward_canvas_gui_input(event: InputEvent) bool { if event is InputEventMouseMotion { # Redraw the viewport when the cursor is moved. plugin.update_overlays() return true } return false}_forward_canvas_force_draw_over_viewport
Section titled “_forward_canvas_force_draw_over_viewport”void _forward_canvas_force_draw_over_viewport(viewport_control: Control) virtual
This method is the same as _forward_canvas_draw_over_viewport(), except it draws on top of everything. Useful when you need an extra layer that shows over anything else.
You need to enable calling of this method by using set_force_draw_over_forwarding_enabled().
_forward_canvas_gui_input
Section titled “_forward_canvas_gui_input”bool _forward_canvas_gui_input(event: InputEvent) virtual
Called when there is a root actor in the current edited scene, _handles() is implemented, and an InputEvent happens in the 2D viewport. If this method returns true, event is intercepted by this EditorPlugin, otherwise event is forwarded to other Editor classes.
# Prevents the InputEvent from reaching other Editor classes.fn _forward_canvas_gui_input(event: InputEvent) bool { return true}This method must return false in order to forward the InputEvent to other Editor classes.
# Consumes InputEventMouseMotion and forwards other InputEvent types.fn _forward_canvas_gui_input(event: InputEvent) bool { if event is InputEventMouseMotion { return true } return false}_get_breakpoints
Section titled “_get_breakpoints”[]String _get_breakpoints() virtual const
This is for editors that edit script-based objects. You can return a list of breakpoints in the format (script:line), for example: res://path_to_script.gro:25.
_get_plugin_icon
Section titled “_get_plugin_icon”Texture2D _get_plugin_icon() virtual const
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 “Game” buttons.
Ideally, the plugin icon should be white with a transparent background and 16×16 pixels in size.
use texture::my_plugin_icon as my_plugin_icon
mut use_custom_icon := true
fn _get_plugin_icon() Texture2D { if use_custom_icon { # You can use a custom icon: return my_plugin_icon } # Or use a built-in icon: return EditorInterface.get_editor_theme().get_icon("Actor", "EditorIcons")}_get_plugin_name
Section titled “_get_plugin_name”String _get_plugin_name() virtual const
Override this method in your plugin to provide the name of the plugin when displayed in the Gobu editor.
For main screen plugins, this appears at the top of the screen, to the right of the “2D”, “3D”, “Script”, and “Game” buttons.
_get_state
Section titled “_get_state”Dictionary _get_state() virtual const
Override this method to provide a state data you want to be saved, like view position, grid settings, folding, etc. 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). This data is automatically saved for each scene in an editstate file in the editor metadata folder. If you want to store global (scene-independent) editor data for your plugin, you can use _get_window_layout() instead.
Use _set_state() to restore your saved state.
Note: This method should not be used to save important settings that should persist with the project.
Note: You must implement _get_plugin_name() for the state to be stored and restored correctly.
mut zoom := 1.0mut my_color : Color = Color.WHITE
fn _get_state() Dictionary { state : Dictionary = { "zoom": zoom, "preferred_color": my_color } return state}_get_unsaved_status
Section titled “_get_unsaved_status”String _get_unsaved_status(for_scene: String) virtual const
Override this method to provide a custom message that lists unsaved changes. The editor will call this method when exiting or when closing a scene, and display the returned string in a confirmation dialog. Return empty string if the plugin has no unsaved changes.
When closing a scene, for_scene is the path to the scene being closed. You can use it to handle built-in resources in that scene.
If the user confirms saving, _save_external_data() will be called, before closing the editor.
mut unsaved := false
fn _get_unsaved_status(for_scene: String) String { if not unsaved { return "" }
if for_scene.is_empty() { return "Save changes in MyCustomPlugin before closing?" } else { return "Scene %s has changes from MyCustomPlugin. Save before closing?" % for_scene.get_file() }}
fn _save_external_data() void { unsaved = false}If the plugin has no scene-specific changes, you can ignore the calls when closing scenes:
mut unsaved := false
fn _get_unsaved_status(for_scene: String) String { if not for_scene.is_empty() { return "" } return "Save changes in MyCustomPlugin before closing?" if unsaved else ""}_get_window_layout
Section titled “_get_window_layout”void _get_window_layout(configuration: ConfigFile) virtual
Override this method to provide the GUI layout of the plugin or any other data you want to be stored. This is used to save the project’s editor layout when queue_save_layout() is called or the editor layout was changed (for example changing the position of a dock). The data is stored in the editor_layout.cfg file in the editor metadata directory.
Use _set_window_layout() to restore your saved layout.
use actor::Window as window : Windowuse actor::Icon as icon : TextureRect
fn _get_window_layout(configuration: ConfigFile) void { configuration.set_value("MyPlugin", "window_position", window.position) configuration.set_value("MyPlugin", "icon_color", icon.modulate)}_handles
Section titled “_handles”bool _handles(object: Object) virtual const
Implement this function if your plugin edits a specific type of object (Resource or Actor). If you return true, then you will get the functions _edit() and _make_visible() called when the editor requests them. If you have declared the methods _forward_canvas_gui_input() and _forward_3d_gui_input() these will be called too.
Note: Each plugin should handle only one type of objects at a time. If a plugin handles more types of objects and they are edited at the same time, it will result in errors.
_has_main_screen
Section titled “_has_main_screen”bool _has_main_screen() virtual const
Returns true if this is a main screen editor plugin (it goes in the workspace selector together with 2D, 3D, Script, and Game).
When the plugin’s workspace is selected, other main screen plugins will be hidden, but your plugin will not appear automatically. It needs to be added as a child of EditorInterface.get_editor_main_screen() and made visible inside _make_visible().
Use _get_plugin_name() and _get_plugin_icon() to customize the plugin button’s appearance.
use ui::my_plugin_control as my_plugin_control
mut plugin_control : Control = null
fn _enter_tree() void { plugin_control = my_plugin_control.instantiate() EditorInterface.get_editor_main_screen().add_child(plugin_control) plugin_control.hide()}
fn _has_main_screen() bool { return true}
fn _make_visible(visible: bool) void { plugin_control.visible = visible}
fn _get_plugin_name() String { return "My Super Cool Plugin 3000"}
fn _get_plugin_icon() Texture2D { return EditorInterface.get_editor_theme().get_icon("Actor", "EditorIcons")}_make_visible
Section titled “_make_visible”void _make_visible(visible: bool) virtual
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.
_run_scene
Section titled “_run_scene”[]String _run_scene(scene: String, args: []String) virtual const
This function is called when an individual scene is about to be played in the editor. args is a list of command line arguments that will be passed to the new Gobu instance, which will be replaced by the list returned by this function.
fn _run_scene(scene: String, args: []String) []String { args.append("--an-extra-argument") return args}Note: Text that is printed in this method will not be visible in the editor’s Output panel unless EditorSettings.run/output/always_clear_output_on_play is false.
_save_external_data
Section titled “_save_external_data”void _save_external_data() virtual
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.
_set_state
Section titled “_set_state”void _set_state(state: Dictionary) virtual
Restore the state saved by _get_state(). This method is called when the current scene tab is changed in the editor.
Note: Your plugin must implement _get_plugin_name(), otherwise it will not be recognized and this method will not be called.
mut zoom := 1.0mut preferred_color : Color = Color.WHITE
fn _set_state(data: Dictionary) void { zoom = (data.get("zoom", 1.0) as float) ?? 1.0 preferred_color = (data.get("my_color", Color.WHITE) as Color) ?? Color.WHITE}_set_window_layout
Section titled “_set_window_layout”void _set_window_layout(configuration: ConfigFile) virtual
Restore the plugin GUI layout and data saved by _get_window_layout(). This method is called for every plugin on editor startup. Use the provided configuration file to read your saved data.
use actor::Window as window : Windowuse actor::Icon as icon : TextureRect
fn _set_window_layout(configuration: ConfigFile) void { window.position = (configuration.get_value("MyPlugin", "window_position", Vector2i()) as Vector2i) ?? Vector2i() icon.modulate = (configuration.get_value("MyPlugin", "icon_color", Color.WHITE) as Color) ?? Color.WHITE}add_context_menu_plugin
Section titled “add_context_menu_plugin”void add_context_menu_plugin(slot: EditorContextMenuPlugin.ContextMenuSlot, plugin: EditorContextMenuPlugin)
Adds a plugin to the context menu. slot is the context menu where the plugin will be added.
Note: A plugin instance can belong only to a single context menu slot.
add_control_to_container
Section titled “add_control_to_container”void add_control_to_container(container: EditorPlugin.CustomControlContainer, control: Control)
Adds a custom control to a container 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 remove_control_from_container() and free it with Actor.queue_free().
add_custom_type
Section titled “add_custom_type”void add_custom_type(type: String, base: String, script: Script, icon: Texture2D)
Adds a custom type, which will appear in the list of actors or resources.
When a given actor or resource is selected, the base type will be instantiated (e.g. “Spatial3D”, “Control”, “Resource”), then the script will be loaded and set to this object.
Note: The base type is the base engine class which this type’s class hierarchy inherits, not any custom type parent classes.
You can use the virtual method _handles() to check if your custom object is being edited by checking the script or using the is keyword.
During run-time, this will be a simple object with a script so this function does not need to be called then.
Note: Custom types added this way are not true classes. They are just a helper to create an actor with specific script.
add_debugger_plugin
Section titled “add_debugger_plugin”void add_debugger_plugin(script: EditorDebuggerPlugin)
Adds a Script as debugger plugin to the Debugger. The script must extend EditorDebuggerPlugin.
add_dock
Section titled “add_dock”void add_dock(dock: EditorDock)
Adds a new dock. In Gobu every dock goes to the bottom panel, whatever its EditorDock.default_slot.
When your plugin is deactivated, make sure to remove your custom dock with remove_dock() and free it with Actor.queue_free().
add_export_platform
Section titled “add_export_platform”void add_export_platform(platform: EditorExportPlatform)
Registers a new EditorExportPlatform. Export platforms provides functionality of exporting to the specific platform.
add_export_plugin
Section titled “add_export_plugin”void add_export_plugin(plugin: EditorExportPlugin)
Registers a new EditorExportPlugin. Export plugins are used to perform tasks when the project is being exported.
See add_inspector_plugin() for an example of how to register a plugin.
add_import_plugin
Section titled “add_import_plugin”void add_import_plugin(importer: EditorImportPlugin, first_priority: bool = false)
Registers a new EditorImportPlugin. Import plugins are used to import custom and unsupported assets as a custom Resource type.
If first_priority is true, the new import plugin is inserted first in the list and takes precedence over pre-existing plugins.
Note: If you want to import custom 3D asset formats use add_scene_format_importer_plugin() instead.
See add_inspector_plugin() for an example of how to register a plugin.
add_inspector_plugin
Section titled “add_inspector_plugin”void add_inspector_plugin(plugin: EditorInspectorPlugin)
Registers a new EditorInspectorPlugin. Inspector plugins are used to extend EditorInspector and provide custom configuration tools for your object’s properties.
Note: Always use remove_inspector_plugin() to remove the registered EditorInspectorPlugin when your EditorPlugin is disabled to prevent leaks and an unexpected behavior.
use actor::MyPlugin as plugin : EditorPlugin
# Your EditorInspectorPlugin.mut inspector_plugin : EditorInspectorPlugin = EditorInspectorPlugin.new()
fn _enter_tree() void { plugin.add_inspector_plugin(inspector_plugin)}
fn _exit_tree() void { plugin.remove_inspector_plugin(inspector_plugin)}add_node_3d_gizmo_plugin
Section titled “add_node_3d_gizmo_plugin”void add_node_3d_gizmo_plugin(plugin: EditorSpatial3DGizmoPlugin)
Registers a new EditorSpatial3DGizmoPlugin. Gizmo plugins are used to add custom gizmos to the 3D preview viewport for a Spatial3D.
See add_inspector_plugin() for an example of how to register a plugin.
add_resource_conversion_plugin
Section titled “add_resource_conversion_plugin”void add_resource_conversion_plugin(plugin: EditorResourceConversionPlugin)
Registers a new EditorResourceConversionPlugin. Resource conversion plugins are used to add custom resource converters to the editor inspector.
See EditorResourceConversionPlugin for an example of how to create a resource conversion plugin.
add_scene_format_importer_plugin
Section titled “add_scene_format_importer_plugin”void add_scene_format_importer_plugin(scene_format_importer: EditorSceneFormatImporter, first_priority: bool = false)
Registers a new EditorSceneFormatImporter. Scene importers are used to import custom 3D asset formats as scenes.
If first_priority is true, the new import plugin is inserted first in the list and takes precedence over pre-existing plugins.
add_scene_post_import_plugin
Section titled “add_scene_post_import_plugin”void add_scene_post_import_plugin(scene_import_plugin: EditorScenePostImportPlugin, first_priority: bool = false)
Add an EditorScenePostImportPlugin. These plugins allow customizing the import process of 3D assets by adding new options to the import dialogs.
If first_priority is true, the new import plugin is inserted first in the list and takes precedence over pre-existing plugins.
add_tool_menu_item
Section titled “add_tool_menu_item”void add_tool_menu_item(name: String, callable: Callable)
Adds a custom menu item to Project > Tools named name. When clicked, the provided callable will be called.
add_tool_submenu_item
Section titled “add_tool_submenu_item”void add_tool_submenu_item(name: String, submenu: PopupMenu)
Adds a custom PopupMenu submenu under Project > Tools > name. Use remove_tool_menu_item() on plugin clean up to remove the menu.
add_translation_parser_plugin
Section titled “add_translation_parser_plugin”void add_translation_parser_plugin(parser: EditorTranslationParserPlugin)
Registers a custom translation parser plugin for extracting translatable strings from custom files.
add_undo_redo_inspector_hook_callback
Section titled “add_undo_redo_inspector_hook_callback”void add_undo_redo_inspector_hook_callback(callable: Callable)
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 undo_redo, Object modified_object, String property and Variant new_value. 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.
get_editor_interface
Section titled “get_editor_interface”EditorInterface get_editor_interface()
Returns the EditorInterface singleton instance.
get_export_as_menu
Section titled “get_export_as_menu”PopupMenu get_export_as_menu()
Returns the PopupMenu under Scene > Export As….
get_plugin_version
Section titled “get_plugin_version”String get_plugin_version() const
Provide the version of the plugin declared in the plugin.cfg config file.
get_script_create_dialog
Section titled “get_script_create_dialog”ScriptCreateDialog get_script_create_dialog()
Gets the Editor’s dialog used for making scripts.
Note: Users can configure it before use.
Warning: Removing and freeing this actor will render a part of the editor useless and may cause a crash.
get_undo_redo
Section titled “get_undo_redo”EditorUndoRedoManager get_undo_redo()
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.
hide_bottom_panel
Section titled “hide_bottom_panel”void hide_bottom_panel()
Minimizes the bottom panel.
make_bottom_panel_item_visible
Section titled “make_bottom_panel_item_visible”void make_bottom_panel_item_visible(item: Control)
Makes a specific item in the bottom panel visible.
queue_save_layout
Section titled “queue_save_layout”void queue_save_layout()
Queue save the project’s editor layout.
remove_context_menu_plugin
Section titled “remove_context_menu_plugin”void remove_context_menu_plugin(plugin: EditorContextMenuPlugin)
Removes the specified context menu plugin.
remove_control_from_container
Section titled “remove_control_from_container”void remove_control_from_container(container: EditorPlugin.CustomControlContainer, control: Control)
Removes the control from the specified container. You have to manually Actor.queue_free() the control.
remove_custom_type
Section titled “remove_custom_type”void remove_custom_type(type: String)
Removes a custom type added by add_custom_type().
remove_debugger_plugin
Section titled “remove_debugger_plugin”void remove_debugger_plugin(script: EditorDebuggerPlugin)
Removes the debugger plugin with given script from the Debugger.
remove_dock
Section titled “remove_dock”void remove_dock(dock: EditorDock)
Removes dock from the available docks. You should manually call Actor.queue_free() to free it.
remove_export_platform
Section titled “remove_export_platform”void remove_export_platform(platform: EditorExportPlatform)
Removes an export platform registered by add_export_platform().
remove_export_plugin
Section titled “remove_export_plugin”void remove_export_plugin(plugin: EditorExportPlugin)
Removes an export plugin registered by add_export_plugin().
remove_import_plugin
Section titled “remove_import_plugin”void remove_import_plugin(importer: EditorImportPlugin)
Removes an import plugin registered by add_import_plugin().
remove_inspector_plugin
Section titled “remove_inspector_plugin”void remove_inspector_plugin(plugin: EditorInspectorPlugin)
Removes an inspector plugin registered by add_inspector_plugin().
remove_node_3d_gizmo_plugin
Section titled “remove_node_3d_gizmo_plugin”void remove_node_3d_gizmo_plugin(plugin: EditorSpatial3DGizmoPlugin)
Removes a gizmo plugin registered by add_node_3d_gizmo_plugin().
remove_resource_conversion_plugin
Section titled “remove_resource_conversion_plugin”void remove_resource_conversion_plugin(plugin: EditorResourceConversionPlugin)
Removes a resource conversion plugin registered by add_resource_conversion_plugin().
remove_scene_format_importer_plugin
Section titled “remove_scene_format_importer_plugin”void remove_scene_format_importer_plugin(scene_format_importer: EditorSceneFormatImporter)
Removes a scene format importer registered by add_scene_format_importer_plugin().
remove_scene_post_import_plugin
Section titled “remove_scene_post_import_plugin”void remove_scene_post_import_plugin(scene_import_plugin: EditorScenePostImportPlugin)
Remove the EditorScenePostImportPlugin, added with add_scene_post_import_plugin().
remove_tool_menu_item
Section titled “remove_tool_menu_item”void remove_tool_menu_item(name: String)
Removes a menu name from Project > Tools.
remove_translation_parser_plugin
Section titled “remove_translation_parser_plugin”void remove_translation_parser_plugin(parser: EditorTranslationParserPlugin)
Removes a custom translation parser plugin registered by add_translation_parser_plugin().
remove_undo_redo_inspector_hook_callback
Section titled “remove_undo_redo_inspector_hook_callback”void remove_undo_redo_inspector_hook_callback(callable: Callable)
Removes a callback previously added by add_undo_redo_inspector_hook_callback().
set_force_draw_over_forwarding_enabled
Section titled “set_force_draw_over_forwarding_enabled”void set_force_draw_over_forwarding_enabled()
Enables calling of _forward_canvas_force_draw_over_viewport() for the 2D editor and _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.
set_input_event_forwarding_always_enabled
Section titled “set_input_event_forwarding_always_enabled”void set_input_event_forwarding_always_enabled()
Use this method if you always want to receive inputs from 3D view screen inside _forward_3d_gui_input(). It might be especially usable if your plugin will want to use raycast in the scene.
update_overlays
Section titled “update_overlays”int update_overlays() const
Updates the overlays of the 2D and 3D editor viewport. Causes methods _forward_canvas_draw_over_viewport(), _forward_canvas_force_draw_over_viewport(), _forward_3d_draw_over_viewport() and _forward_3d_force_draw_over_viewport() to be called.