diff options
Diffstat (limited to 'doc/classes/EditorPlugin.xml')
| -rw-r--r-- | doc/classes/EditorPlugin.xml | 82 |
1 files changed, 57 insertions, 25 deletions
diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index f9bdf1dcd5..ada0ee56a8 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorPlugin" inherits="Node" category="Core" version="3.0-alpha"> +<class name="EditorPlugin" inherits="Node" category="Core" version="3.0-beta"> <brief_description> Used by the editor to extend its functionality. </brief_description> @@ -82,6 +82,14 @@ <description> </description> </method> + <method name="add_scene_import_plugin"> + <return type="void"> + </return> + <argument index="0" name="scene_importer" type="EditorSceneImporter"> + </argument> + <description> + </description> + </method> <method name="add_tool_submenu_item"> <return type="void"> </return> @@ -135,15 +143,20 @@ <description> </description> </method> - <method name="forward_draw_over_canvas" qualifiers="virtual"> + <method name="forward_draw_over_viewport" qualifiers="virtual"> <return type="void"> </return> - <argument index="0" name="canvas_xform" type="Transform2D"> + <argument index="0" name="overlay" type="Control"> </argument> - <argument index="1" name="canvas" type="Control"> + <description> + </description> + </method> + <method name="forward_force_draw_over_viewport" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="overlay" type="Control"> </argument> <description> - This function is called every time the 2D canvas editor draws (which overlays over the edited scene). Drawing over the supplied control will draw over the edited scene. To convert from control coordinates to edited scene coordinates (including zoom and offset), a transform is also provided. If you require this control to be redraw, call [method update_canvas]. </description> </method> <method name="forward_spatial_gui_input" qualifiers="virtual"> @@ -171,6 +184,12 @@ <description> </description> </method> + <method name="get_plugin_icon" qualifiers="virtual"> + <return type="Object"> + </return> + <description> + </description> + </method> <method name="get_plugin_name" qualifiers="virtual"> <return type="String"> </return> @@ -290,6 +309,14 @@ <description> </description> </method> + <method name="remove_scene_import_plugin"> + <return type="void"> + </return> + <argument index="0" name="scene_importer" type="EditorSceneImporter"> + </argument> + <description> + </description> + </method> <method name="save_external_data" qualifiers="virtual"> <return type="void"> </return> @@ -297,6 +324,12 @@ This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources. </description> </method> + <method name="set_force_draw_over_forwarding_enabled"> + <return type="void"> + </return> + <description> + </description> + </method> <method name="set_input_event_forwarding_always_enabled"> <return type="void"> </return> @@ -322,11 +355,10 @@ Restore the plugin GUI layout saved by [method EditorPlugin.get_window_layout]. </description> </method> - <method name="update_canvas"> - <return type="void"> + <method name="update_overlays" qualifiers="const"> + <return type="int"> </return> <description> - Updates the control used to draw the edited scene over the 2D canvas. This is used together with [method forward_canvas_input_event]. </description> </method> </methods> @@ -354,39 +386,39 @@ </signal> </signals> <constants> - <constant name="CONTAINER_TOOLBAR" value="0"> + <constant name="CONTAINER_TOOLBAR" value="0" enum="CustomControlContainer"> </constant> - <constant name="CONTAINER_SPATIAL_EDITOR_MENU" value="1"> + <constant name="CONTAINER_SPATIAL_EDITOR_MENU" value="1" enum="CustomControlContainer"> </constant> - <constant name="CONTAINER_SPATIAL_EDITOR_SIDE" value="2"> + <constant name="CONTAINER_SPATIAL_EDITOR_SIDE" value="2" enum="CustomControlContainer"> </constant> - <constant name="CONTAINER_SPATIAL_EDITOR_BOTTOM" value="3"> + <constant name="CONTAINER_SPATIAL_EDITOR_BOTTOM" value="3" enum="CustomControlContainer"> </constant> - <constant name="CONTAINER_CANVAS_EDITOR_MENU" value="4"> + <constant name="CONTAINER_CANVAS_EDITOR_MENU" value="4" enum="CustomControlContainer"> </constant> - <constant name="CONTAINER_CANVAS_EDITOR_SIDE" value="5"> + <constant name="CONTAINER_CANVAS_EDITOR_SIDE" value="5" enum="CustomControlContainer"> </constant> - <constant name="CONTAINER_CANVAS_EDITOR_BOTTOM" value="6"> + <constant name="CONTAINER_CANVAS_EDITOR_BOTTOM" value="6" enum="CustomControlContainer"> </constant> - <constant name="CONTAINER_PROPERTY_EDITOR_BOTTOM" value="7"> + <constant name="CONTAINER_PROPERTY_EDITOR_BOTTOM" value="7" enum="CustomControlContainer"> </constant> - <constant name="DOCK_SLOT_LEFT_UL" value="0"> + <constant name="DOCK_SLOT_LEFT_UL" value="0" enum="DockSlot"> </constant> - <constant name="DOCK_SLOT_LEFT_BL" value="1"> + <constant name="DOCK_SLOT_LEFT_BL" value="1" enum="DockSlot"> </constant> - <constant name="DOCK_SLOT_LEFT_UR" value="2"> + <constant name="DOCK_SLOT_LEFT_UR" value="2" enum="DockSlot"> </constant> - <constant name="DOCK_SLOT_LEFT_BR" value="3"> + <constant name="DOCK_SLOT_LEFT_BR" value="3" enum="DockSlot"> </constant> - <constant name="DOCK_SLOT_RIGHT_UL" value="4"> + <constant name="DOCK_SLOT_RIGHT_UL" value="4" enum="DockSlot"> </constant> - <constant name="DOCK_SLOT_RIGHT_BL" value="5"> + <constant name="DOCK_SLOT_RIGHT_BL" value="5" enum="DockSlot"> </constant> - <constant name="DOCK_SLOT_RIGHT_UR" value="6"> + <constant name="DOCK_SLOT_RIGHT_UR" value="6" enum="DockSlot"> </constant> - <constant name="DOCK_SLOT_RIGHT_BR" value="7"> + <constant name="DOCK_SLOT_RIGHT_BR" value="7" enum="DockSlot"> </constant> - <constant name="DOCK_SLOT_MAX" value="8"> + <constant name="DOCK_SLOT_MAX" value="8" enum="DockSlot"> </constant> </constants> </class> |