aboutsummaryrefslogtreecommitdiff
path: root/doc/base/classes.xml
diff options
context:
space:
mode:
authorFranklin Sobrinho2016-08-15 14:52:03 -0300
committerRémi Verschelde2016-09-01 08:39:58 +0200
commitdf3d2b25d8088e3475fe868683501e74b5baa065 (patch)
tree117cf0a838fc1276faf14423d3c60d87cab6d45c /doc/base/classes.xml
parent743c63670ec2da8db6be3af34f1bbc3322419667 (diff)
downloadgodot-df3d2b25d8088e3475fe868683501e74b5baa065.tar.gz
godot-df3d2b25d8088e3475fe868683501e74b5baa065.tar.zst
godot-df3d2b25d8088e3475fe868683501e74b5baa065.zip
Update EditorPlugin doc
(cherry picked from commit a27d2e4c291975f4a5e9fabe89501584e33a3326)
Diffstat (limited to 'doc/base/classes.xml')
-rw-r--r--doc/base/classes.xml24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index f53484a11..06101580b 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -11495,6 +11495,13 @@
Get 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="get_window_layout" qualifiers="virtual">
+ <argument index="0" name="layout" type="ConfigFile">
+ </argument>
+ <description>
+ Get the GUI layout of the plugin. This is used to save the project's editor layout when the [method EditorPlugin.queue_save_layout] is called or the editor layout was changed(For example changing the position of a dock).
+ </description>
+ </method>
<method name="handles" qualifiers="virtual">
<return type="bool">
</return>
@@ -11519,6 +11526,11 @@
Remember that you have to manage the visibility of all your editor controls manually.
</description>
</method>
+ <method name="queue_save_layout" qualifiers="const">
+ <description>
+ Queue save the project's editor layout.
+ </description>
+ </method>
<method name="remove_control_from_bottom_panel">
<argument index="0" name="control" type="Control">
</argument>
@@ -11554,6 +11566,11 @@
Remove the import plugin, don't forget to call this on exit.
</description>
</method>
+ <method name="save_external_data" qualifiers="virtual">
+ <description>
+ This method is called after the editor save the project or when the it's closed. It asks the plugin to save edited external scenes/resources.
+ </description>
+ </method>
<method name="set_state" qualifiers="virtual">
<argument index="0" name="state" type="Dictionary">
</argument>
@@ -11561,6 +11578,13 @@
Restore the state saved by [method EditorPlugin.get_state].
</description>
</method>
+ <method name="set_window_layout" qualifiers="virtual">
+ <argument index="0" name="layout" type="ConfigFile">
+ </argument>
+ <description>
+ Restore the plugin GUI layout saved by [method EditorPlugin.get_window_layout].
+ </description>
+ </method>
</methods>
<constants>
<constant name="CONTAINER_TOOLBAR" value="0">