godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2018-05-28 14:55:19 +02:00
parent d794128b14
commit ec28f3d429
156 changed files with 5216 additions and 3596 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
classes/class_editorplugin.rst
View File

@@ -24,16 +24,18 @@ Member Functions
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ToolButton<class_toolbutton>` | :ref:`add_control_to_bottom_panel<class_EditorPlugin_add_control_to_bottom_panel>` **(** :ref:`Control<class_control>` control, :ref:`String<class_string>` title **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_control_to_container<class_EditorPlugin_add_control_to_container>` **(** :ref:`int<class_int>` container, :ref:`Control<class_control>` control **)** |
| void | :ref:`add_control_to_container<class_EditorPlugin_add_control_to_container>` **(** :ref:`CustomControlContainer<enum_editorplugin_customcontrolcontainer>` container, :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_control_to_dock<class_EditorPlugin_add_control_to_dock>` **(** :ref:`int<class_int>` slot, :ref:`Control<class_control>` control **)** |
| void | :ref:`add_control_to_dock<class_EditorPlugin_add_control_to_dock>` **(** :ref:`DockSlot<enum_editorplugin_dockslot>` slot, :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_custom_type<class_EditorPlugin_add_custom_type>` **(** :ref:`String<class_string>` type, :ref:`String<class_string>` base, :ref:`Script<class_script>` script, :ref:`Texture<class_texture>` icon **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_export_plugin<class_EditorPlugin_add_export_plugin>` **(** :ref:`EditorExportPlugin<class_editorexportplugin>` exporter **)** |
| void | :ref:`add_export_plugin<class_EditorPlugin_add_export_plugin>` **(** :ref:`EditorExportPlugin<class_editorexportplugin>` plugin **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_import_plugin<class_EditorPlugin_add_import_plugin>` **(** :ref:`EditorImportPlugin<class_editorimportplugin>` importer **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_inspector_plugin<class_EditorPlugin_add_inspector_plugin>` **(** :ref:`EditorInspectorPlugin<class_editorinspectorplugin>` plugin **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_scene_import_plugin<class_EditorPlugin_add_scene_import_plugin>` **(** :ref:`EditorSceneImporter<class_editorsceneimporter>` scene_importer **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_tool_menu_item<class_EditorPlugin_add_tool_menu_item>` **(** :ref:`String<class_string>` name, :ref:`Object<class_object>` handler, :ref:`String<class_string>` callback, :ref:`Variant<class_variant>` ud=null **)** |
@@ -42,6 +44,8 @@ Member Functions
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`apply_changes<class_EditorPlugin_apply_changes>` **(** **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`build<class_EditorPlugin_build>` **(** **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_EditorPlugin_clear>` **(** **)** virtual |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorSpatialGizmo<class_editorspatialgizmo>` | :ref:`create_spatial_gizmo<class_EditorPlugin_create_spatial_gizmo>` **(** :ref:`Spatial<class_spatial>` for_spatial **)** virtual |
@@ -86,16 +90,18 @@ Member Functions
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_control_from_bottom_panel<class_EditorPlugin_remove_control_from_bottom_panel>` **(** :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_control_from_container<class_EditorPlugin_remove_control_from_container>` **(** :ref:`int<class_int>` container, :ref:`Control<class_control>` control **)** |
| void | :ref:`remove_control_from_container<class_EditorPlugin_remove_control_from_container>` **(** :ref:`CustomControlContainer<enum_editorplugin_customcontrolcontainer>` container, :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_control_from_docks<class_EditorPlugin_remove_control_from_docks>` **(** :ref:`Control<class_control>` control **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_custom_type<class_EditorPlugin_remove_custom_type>` **(** :ref:`String<class_string>` type **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_export_plugin<class_EditorPlugin_remove_export_plugin>` **(** :ref:`EditorExportPlugin<class_editorexportplugin>` exporter **)** |
| void | :ref:`remove_export_plugin<class_EditorPlugin_remove_export_plugin>` **(** :ref:`EditorExportPlugin<class_editorexportplugin>` plugin **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_import_plugin<class_EditorPlugin_remove_import_plugin>` **(** :ref:`EditorImportPlugin<class_editorimportplugin>` importer **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_inspector_plugin<class_EditorPlugin_remove_inspector_plugin>` **(** :ref:`EditorInspectorPlugin<class_editorinspectorplugin>` plugin **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_scene_import_plugin<class_EditorPlugin_remove_scene_import_plugin>` **(** :ref:`EditorSceneImporter<class_editorsceneimporter>` scene_importer **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_tool_menu_item<class_EditorPlugin_remove_tool_menu_item>` **(** :ref:`String<class_string>` name **)** |
@@ -122,6 +128,10 @@ Signals
Emitted when user change main screen view (2D, 3D, Script, AssetLib). Works also with screens which are defined by plugins.
.. _class_EditorPlugin_resource_saved:
- **resource_saved** **(** :ref:`Object<class_object>` resource **)**
.. _class_EditorPlugin_scene_changed:
- **scene_changed** **(** :ref:`Object<class_object>` scene_root **)**
@@ -188,7 +198,7 @@ Add a control to the bottom panel (together with Output, Debug, Animation, etc).
.. _class_EditorPlugin_add_control_to_container:
- void **add_control_to_container** **(** :ref:`int<class_int>` container, :ref:`Control<class_control>` control **)**
- void **add_control_to_container** **(** :ref:`CustomControlContainer<enum_editorplugin_customcontrolcontainer>` container, :ref:`Control<class_control>` control **)**
Add a custom control to a container (see CONTAINER\_\* enum). There are many locations where custom controls can be added in the editor UI.
@@ -198,7 +208,7 @@ If your plugin is being removed, also make sure to remove your custom controls t
.. _class_EditorPlugin_add_control_to_dock:
- void **add_control_to_dock** **(** :ref:`int<class_int>` slot, :ref:`Control<class_control>` control **)**
- void **add_control_to_dock** **(** :ref:`DockSlot<enum_editorplugin_dockslot>` slot, :ref:`Control<class_control>` control **)**
Add the control to a specific dock slot (see DOCK\_\* enum for options).
@@ -220,12 +230,16 @@ During run-time, this will be a simple object with a script so this function doe
.. _class_EditorPlugin_add_export_plugin:
- void **add_export_plugin** **(** :ref:`EditorExportPlugin<class_editorexportplugin>` exporter **)**
- void **add_export_plugin** **(** :ref:`EditorExportPlugin<class_editorexportplugin>` plugin **)**
.. _class_EditorPlugin_add_import_plugin:
- void **add_import_plugin** **(** :ref:`EditorImportPlugin<class_editorimportplugin>` importer **)**
.. _class_EditorPlugin_add_inspector_plugin:
- void **add_inspector_plugin** **(** :ref:`EditorInspectorPlugin<class_editorinspectorplugin>` plugin **)**
.. _class_EditorPlugin_add_scene_import_plugin:
- void **add_scene_import_plugin** **(** :ref:`EditorSceneImporter<class_editorsceneimporter>` scene_importer **)**
@@ -248,6 +262,10 @@ This method is called when the editor is about to save the project, switch to an
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.
.. _class_EditorPlugin_build:
- :ref:`bool<class_bool>` **build** **(** **)** virtual
.. _class_EditorPlugin_clear:
- void **clear** **(** **)** virtual
@@ -370,7 +388,7 @@ Remove the control from the bottom panel. Don't forget to call this if you added
.. _class_EditorPlugin_remove_control_from_container:
- void **remove_control_from_container** **(** :ref:`int<class_int>` container, :ref:`Control<class_control>` control **)**
- void **remove_control_from_container** **(** :ref:`CustomControlContainer<enum_editorplugin_customcontrolcontainer>` container, :ref:`Control<class_control>` control **)**
Remove the control from the specified container. Use it when cleaning up after adding a control with :ref:`add_control_to_container<class_EditorPlugin_add_control_to_container>`. Note that you can simply free the control if you won't use it anymore.
@@ -388,12 +406,16 @@ Remove a custom type added by :ref:`EditorPlugin.add_custom_type<class_EditorPlu
.. _class_EditorPlugin_remove_export_plugin:
- void **remove_export_plugin** **(** :ref:`EditorExportPlugin<class_editorexportplugin>` exporter **)**
- void **remove_export_plugin** **(** :ref:`EditorExportPlugin<class_editorexportplugin>` plugin **)**
.. _class_EditorPlugin_remove_import_plugin:
- void **remove_import_plugin** **(** :ref:`EditorImportPlugin<class_editorimportplugin>` importer **)**
.. _class_EditorPlugin_remove_inspector_plugin:
- void **remove_inspector_plugin** **(** :ref:`EditorInspectorPlugin<class_editorinspectorplugin>` plugin **)**
.. _class_EditorPlugin_remove_scene_import_plugin:
- void **remove_scene_import_plugin** **(** :ref:`EditorSceneImporter<class_editorsceneimporter>` scene_importer **)**