aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZher Huei Lee2016-02-28 20:09:15 +0000
committerZher Huei Lee2016-02-28 20:09:15 +0000
commit3546403af2a95e6d209ce1113e78bef7bfb9440b (patch)
tree1ad99c0d87c7e9b892795dc55b99574411796618
parentd8ac5cff579bb454b945eaf6c47f4240fb431570 (diff)
downloadgodot-3546403af2a95e6d209ce1113e78bef7bfb9440b.tar.gz
godot-3546403af2a95e6d209ce1113e78bef7bfb9440b.tar.zst
godot-3546403af2a95e6d209ce1113e78bef7bfb9440b.zip
Updated the docs for EditorPlugin
One thing to note is that visibilty of the bottom panel items are automatically managed by the buttons along the bottom.
-rw-r--r--doc/base/classes.xml20
1 files changed, 13 insertions, 7 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index 5915805b7..ce0d93b89 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -10252,21 +10252,18 @@ Returns an empty String "" at the end of the list.
remove your custom controls too.
</description>
</method>
- <method name="add_control_to_bottom_dock">
+ <method name="add_control_to_bottom_panel">
<argument index="0" name="control" type="Control">
</argument>
<argument index="1" name="title" type="String">
</argument>
<description>
- Add a control to the bottom dock (together with
+ Add a control to the bottom panel (together with
Output, Debug, Animation, etc).
- Please remember that you have to manage the
- visibility of your custom controls yourself (and likely
- hide it after adding it).
-
If your plugin is being removed, also make sure to
- remove your custom controls too.
+ remove your control by calling [method
+ remove_control_from_bottom_panel].
</description>
</method>
<method name="add_control_to_dock">
@@ -10297,6 +10294,15 @@ Returns an empty String "" at the end of the list.
the layout and remove it cleanly.
</description>
</method>
+ <method name="remove_control_from_bottom_panel">
+ <argument index="0" name="control" type="Control">
+ </argument>
+ <description>
+ Remove the control from the bottom panel. Don't forget
+ to call this if you added one, so the editor can
+ remove it cleanly.
+ </description>
+ </method>
<method name="add_custom_type">
<argument index="0" name="type" type="String">
</argument>