asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update EditorPlugin doc

Browse source 
(cherry picked from commit a27d2e4c29)
This commit is contained in:
Franklin Sobrinho 2016-08-15 14:52:03 -03:00 committed by Rémi Verschelde
parent 743c63670e
commit df3d2b25d8
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
doc/base/classes.xml
View file

@ -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. 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> </description>
</method> </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"> <method name="handles" qualifiers="virtual">
<return type="bool"> <return type="bool">
</return> </return>
@ -11519,6 +11526,11 @@
Remember that you have to manage the visibility of all your editor controls manually. Remember that you have to manage the visibility of all your editor controls manually.
</description> </description>
</method> </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"> <method name="remove_control_from_bottom_panel">
<argument index="0" name="control" type="Control"> <argument index="0" name="control" type="Control">
</argument> </argument>
@ -11554,6 +11566,11 @@
Remove the import plugin, don't forget to call this on exit. Remove the import plugin, don't forget to call this on exit.
</description> </description>
</method> </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"> <method name="set_state" qualifiers="virtual">
<argument index="0" name="state" type="Dictionary"> <argument index="0" name="state" type="Dictionary">
</argument> </argument>
@ -11561,6 +11578,13 @@
Restore the state saved by [method EditorPlugin.get_state]. Restore the state saved by [method EditorPlugin.get_state].
</description> </description>
</method> </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> </methods>
<constants> <constants>
<constant name="CONTAINER_TOOLBAR" value="0"> <constant name="CONTAINER_TOOLBAR" value="0">