diff options
Diffstat (limited to 'doc/classes/EditorPlugin.xml')
| -rw-r--r-- | doc/classes/EditorPlugin.xml | 150 |
1 files changed, 75 insertions, 75 deletions
diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 2930c2ec22..fdd3807b69 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -38,7 +38,7 @@ </method> <method name="_edit" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="object" type="Variant" /> + <param index="0" name="object" type="Variant" /> <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> @@ -51,7 +51,7 @@ </method> <method name="_forward_3d_draw_over_viewport" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="viewport_control" type="Control" /> + <param index="0" name="viewport_control" type="Control" /> <description> 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]. [codeblocks] @@ -89,7 +89,7 @@ </method> <method name="_forward_3d_force_draw_over_viewport" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="viewport_control" type="Control" /> + <param index="0" name="viewport_control" type="Control" /> <description> 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. You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled]. @@ -97,10 +97,10 @@ </method> <method name="_forward_3d_gui_input" qualifiers="virtual"> <return type="int" /> - <argument index="0" name="viewport_camera" type="Camera3D" /> - <argument index="1" name="event" type="InputEvent" /> + <param index="0" name="viewport_camera" type="Camera3D" /> + <param index="1" name="event" type="InputEvent" /> <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: + 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 [param event], otherwise forwards [param event] to other Editor classes. Example: [codeblocks] [gdscript] # Prevents the InputEvent to reach other Editor classes. @@ -134,7 +134,7 @@ </method> <method name="_forward_canvas_draw_over_viewport" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="viewport_control" type="Control" /> + <param index="0" name="viewport_control" type="Control" /> <description> 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]. [codeblocks] @@ -172,7 +172,7 @@ </method> <method name="_forward_canvas_force_draw_over_viewport" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="viewport_control" type="Control" /> + <param index="0" name="viewport_control" type="Control" /> <description> 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. You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled]. @@ -180,9 +180,9 @@ </method> <method name="_forward_canvas_gui_input" qualifiers="virtual"> <return type="bool" /> - <argument index="0" name="event" type="InputEvent" /> + <param index="0" name="event" type="InputEvent" /> <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: + 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 [param event], otherwise forwards [param event] to other Editor classes. Example: [codeblocks] [gdscript] # Prevents the InputEvent to reach other Editor classes. @@ -274,7 +274,7 @@ </method> <method name="_get_window_layout" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="configuration" type="ConfigFile" /> + <param index="0" name="configuration" type="ConfigFile" /> <description> 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 [method 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 [code]editor_layout.cfg[/code] file in the editor metadata directory. Use [method _set_window_layout] to restore your saved layout. @@ -287,7 +287,7 @@ </method> <method name="_handles" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="object" type="Variant" /> + <param index="0" name="object" type="Variant" /> <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_3d_gui_input] these will be called too. </description> @@ -322,7 +322,7 @@ </method> <method name="_make_visible" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="visible" type="bool" /> + <param index="0" name="visible" type="bool" /> <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. @@ -336,7 +336,7 @@ </method> <method name="_set_state" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="state" type="Dictionary" /> + <param index="0" name="state" type="Dictionary" /> <description> Restore the state saved by [method _get_state]. This method is called when the current scene tab is changed in the editor. [b]Note:[/b] Your plugin must implement [method _get_plugin_name], otherwise it will not be recognized and this method will not be called. @@ -349,9 +349,9 @@ </method> <method name="_set_window_layout" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="configuration" type="ConfigFile" /> + <param index="0" name="configuration" type="ConfigFile" /> <description> - Restore the plugin GUI layout and data saved by [method _get_window_layout]. This method is called for every plugin on editor startup. Use the provided [code]configuration[/code] file to read your saved data. + Restore the plugin GUI layout and data saved by [method _get_window_layout]. This method is called for every plugin on editor startup. Use the provided [param configuration] file to read your saved data. [codeblock] func _set_window_layout(configuration): $Window.position = configuration.get_value("MyPlugin", "window_position", Vector2()) @@ -361,24 +361,24 @@ </method> <method name="add_autoload_singleton"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="path" type="String" /> + <param index="0" name="name" type="String" /> + <param index="1" name="path" type="String" /> <description> - Adds a script at [code]path[/code] to the Autoload list as [code]name[/code]. + Adds a script at [param path] to the Autoload list as [param name]. </description> </method> <method name="add_control_to_bottom_panel"> <return type="Button" /> - <argument index="0" name="control" type="Control" /> - <argument index="1" name="title" type="String" /> + <param index="0" name="control" type="Control" /> + <param index="1" name="title" type="String" /> <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" /> - <argument index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer" /> - <argument index="1" name="control" type="Control" /> + <param index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer" /> + <param index="1" name="control" type="Control" /> <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). @@ -387,8 +387,8 @@ </method> <method name="add_control_to_dock"> <return type="void" /> - <argument index="0" name="slot" type="int" enum="EditorPlugin.DockSlot" /> - <argument index="1" name="control" type="Control" /> + <param index="0" name="slot" type="int" enum="EditorPlugin.DockSlot" /> + <param index="1" name="control" type="Control" /> <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. @@ -397,10 +397,10 @@ </method> <method name="add_custom_type"> <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" /> + <param index="0" name="type" type="String" /> + <param index="1" name="base" type="String" /> + <param index="2" name="script" type="Script" /> + <param index="3" name="icon" type="Texture2D" /> <description> Adds a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed. 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. @@ -410,14 +410,14 @@ </method> <method name="add_debugger_plugin"> <return type="void" /> - <argument index="0" name="script" type="Script" /> + <param index="0" name="script" type="Script" /> <description> Adds a [Script] as debugger plugin to the Debugger. The script must extend [EditorDebuggerPlugin]. </description> </method> <method name="add_export_plugin"> <return type="void" /> - <argument index="0" name="plugin" type="EditorExportPlugin" /> + <param index="0" name="plugin" type="EditorExportPlugin" /> <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. @@ -425,18 +425,18 @@ </method> <method name="add_import_plugin"> <return type="void" /> - <argument index="0" name="importer" type="EditorImportPlugin" /> - <argument index="1" name="first_priority" type="bool" default="false" /> + <param index="0" name="importer" type="EditorImportPlugin" /> + <param index="1" name="first_priority" type="bool" default="false" /> <description> Registers a new [EditorImportPlugin]. Import plugins are used to import custom and unsupported assets as a custom [Resource] type. - 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. + If [param first_priority] is [code]true[/code], the new import plugin is inserted first in the list and takes precedence over pre-existing plugins. [b]Note:[/b] If you want to import custom 3D asset formats use [method add_scene_format_importer_plugin] instead. See [method add_inspector_plugin] for an example of how to register a plugin. </description> </method> <method name="add_inspector_plugin"> <return type="void" /> - <argument index="0" name="plugin" type="EditorInspectorPlugin" /> + <param index="0" name="plugin" type="EditorInspectorPlugin" /> <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. @@ -456,25 +456,25 @@ </method> <method name="add_scene_format_importer_plugin"> <return type="void" /> - <argument index="0" name="scene_format_importer" type="EditorSceneFormatImporter" /> - <argument index="1" name="first_priority" type="bool" default="false" /> + <param index="0" name="scene_format_importer" type="EditorSceneFormatImporter" /> + <param index="1" name="first_priority" type="bool" default="false" /> <description> Registers a new [EditorSceneFormatImporter]. Scene importers are used to import custom 3D asset formats as scenes. - 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. + If [param first_priority] is [code]true[/code], the new import plugin is inserted first in the list and takes precedence over pre-existing plugins. </description> </method> <method name="add_scene_post_import_plugin"> <return type="void" /> - <argument index="0" name="scene_import_plugin" type="EditorScenePostImportPlugin" /> - <argument index="1" name="first_priority" type="bool" default="false" /> + <param index="0" name="scene_import_plugin" type="EditorScenePostImportPlugin" /> + <param index="1" name="first_priority" type="bool" default="false" /> <description> Add a [EditorScenePostImportPlugin]. These plugins allow customizing the import process of 3D assets by adding new options to the import dialogs. - 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. + If [param first_priority] is [code]true[/code], the new import plugin is inserted first in the list and takes precedence over pre-existing plugins. </description> </method> <method name="add_spatial_gizmo_plugin"> <return type="void" /> - <argument index="0" name="plugin" type="EditorNode3DGizmoPlugin" /> + <param index="0" name="plugin" type="EditorNode3DGizmoPlugin" /> <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. @@ -482,30 +482,30 @@ </method> <method name="add_tool_menu_item"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="callable" type="Callable" /> + <param index="0" name="name" type="String" /> + <param index="1" name="callable" type="Callable" /> <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. + Adds a custom menu item to [b]Project > Tools[/b] named [param name]. When clicked, the provided [param callable] will be called. </description> </method> <method name="add_tool_submenu_item"> <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="submenu" type="PopupMenu" /> + <param index="0" name="name" type="String" /> + <param index="1" name="submenu" type="PopupMenu" /> <description> - 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. + Adds a custom [PopupMenu] submenu under [b]Project > Tools >[/b] [param name]. Use [code]remove_tool_menu_item(name)[/code] on plugin clean up to remove the menu. </description> </method> <method name="add_translation_parser_plugin"> <return type="void" /> - <argument index="0" name="parser" type="EditorTranslationParserPlugin" /> + <param index="0" name="parser" type="EditorTranslationParserPlugin" /> <description> Registers a custom translation parser plugin for extracting translatable strings from custom files. </description> </method> <method name="add_undo_redo_inspector_hook_callback"> <return type="void" /> - <argument index="0" name="callable" type="Callable" /> + <param index="0" name="callable" type="Callable" /> <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. @@ -532,7 +532,7 @@ </description> </method> <method name="get_undo_redo"> - <return type="UndoRedo" /> + <return type="EditorUndoRedoManager" /> <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> @@ -545,7 +545,7 @@ </method> <method name="make_bottom_panel_item_visible"> <return type="void" /> - <argument index="0" name="item" type="Control" /> + <param index="0" name="item" type="Control" /> <description> Makes a specific item in the bottom panel visible. </description> @@ -558,106 +558,106 @@ </method> <method name="remove_autoload_singleton"> <return type="void" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> - Removes an Autoload [code]name[/code] from the list. + Removes an Autoload [param name] from the list. </description> </method> <method name="remove_control_from_bottom_panel"> <return type="void" /> - <argument index="0" name="control" type="Control" /> + <param index="0" name="control" type="Control" /> <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" /> - <argument index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer" /> - <argument index="1" name="control" type="Control" /> + <param index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer" /> + <param index="1" name="control" type="Control" /> <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" /> - <argument index="0" name="control" type="Control" /> + <param index="0" name="control" type="Control" /> <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" /> - <argument index="0" name="type" type="String" /> + <param index="0" name="type" type="String" /> <description> Removes a custom type added by [method add_custom_type]. </description> </method> <method name="remove_debugger_plugin"> <return type="void" /> - <argument index="0" name="script" type="Script" /> + <param index="0" name="script" type="Script" /> <description> Removes the debugger plugin with given script from the Debugger. </description> </method> <method name="remove_export_plugin"> <return type="void" /> - <argument index="0" name="plugin" type="EditorExportPlugin" /> + <param index="0" name="plugin" type="EditorExportPlugin" /> <description> Removes an export plugin registered by [method add_export_plugin]. </description> </method> <method name="remove_import_plugin"> <return type="void" /> - <argument index="0" name="importer" type="EditorImportPlugin" /> + <param index="0" name="importer" type="EditorImportPlugin" /> <description> Removes an import plugin registered by [method add_import_plugin]. </description> </method> <method name="remove_inspector_plugin"> <return type="void" /> - <argument index="0" name="plugin" type="EditorInspectorPlugin" /> + <param index="0" name="plugin" type="EditorInspectorPlugin" /> <description> Removes an inspector plugin registered by [method add_import_plugin] </description> </method> <method name="remove_scene_format_importer_plugin"> <return type="void" /> - <argument index="0" name="scene_format_importer" type="EditorSceneFormatImporter" /> + <param 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"> <return type="void" /> - <argument index="0" name="scene_import_plugin" type="EditorScenePostImportPlugin" /> + <param index="0" name="scene_import_plugin" type="EditorScenePostImportPlugin" /> <description> Remove the [EditorScenePostImportPlugin], added with [method add_scene_post_import_plugin]. </description> </method> <method name="remove_spatial_gizmo_plugin"> <return type="void" /> - <argument index="0" name="plugin" type="EditorNode3DGizmoPlugin" /> + <param index="0" name="plugin" type="EditorNode3DGizmoPlugin" /> <description> Removes a gizmo plugin registered by [method add_spatial_gizmo_plugin]. </description> </method> <method name="remove_tool_menu_item"> <return type="void" /> - <argument index="0" name="name" type="String" /> + <param index="0" name="name" type="String" /> <description> - Removes a menu [code]name[/code] from [b]Project > Tools[/b]. + Removes a menu [param name] from [b]Project > Tools[/b]. </description> </method> <method name="remove_translation_parser_plugin"> <return type="void" /> - <argument index="0" name="parser" type="EditorTranslationParserPlugin" /> + <param index="0" name="parser" type="EditorTranslationParserPlugin" /> <description> Removes a custom translation parser plugin registered by [method add_translation_parser_plugin]. </description> </method> <method name="remove_undo_redo_inspector_hook_callback"> <return type="void" /> - <argument index="0" name="callable" type="Callable" /> + <param index="0" name="callable" type="Callable" /> <description> Removes a callback previsously added by [method add_undo_redo_inspector_hook_callback]. </description> @@ -683,7 +683,7 @@ </methods> <signals> <signal name="main_screen_changed"> - <argument index="0" name="screen_name" type="String" /> + <param index="0" name="screen_name" type="String" /> <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> @@ -693,18 +693,18 @@ </description> </signal> <signal name="resource_saved"> - <argument index="0" name="resource" type="Resource" /> + <param index="0" name="resource" type="Resource" /> <description> </description> </signal> <signal name="scene_changed"> - <argument index="0" name="scene_root" type="Node" /> + <param index="0" name="scene_root" type="Node" /> <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" /> + <param index="0" name="filepath" type="String" /> <description> Emitted when user closes a scene. The argument is file path to a closed scene. </description> @@ -729,7 +729,7 @@ </constant> <constant name="CONTAINER_CANVAS_EDITOR_BOTTOM" value="8" enum="CustomControlContainer"> </constant> - <constant name="CONTAINER_PROPERTY_EDITOR_BOTTOM" value="9" enum="CustomControlContainer"> + <constant name="CONTAINER_INSPECTOR_BOTTOM" value="9" enum="CustomControlContainer"> </constant> <constant name="CONTAINER_PROJECT_SETTING_TAB_LEFT" value="10" enum="CustomControlContainer"> </constant> |