From 68d73ecf60b35c06ee645fe0fed2b4dc426e0f81 Mon Sep 17 00:00:00 2001
From: Aaron Franke <arnfranke@yahoo.com>
Date: Mon, 2 Mar 2020 20:53:41 -0500
Subject: Document EditorPlugin get_plugin_icon and get_plugin_name

The return value's type hint is now accurate.
---
 doc/classes/EditorPlugin.xml | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml
index d17fd0a661..587fd51f1e 100644
--- a/doc/classes/EditorPlugin.xml
+++ b/doc/classes/EditorPlugin.xml
@@ -267,15 +267,27 @@
 			</description>
 		</method>
 		<method name="get_plugin_icon" qualifiers="virtual">
-			<return type="Object">
+			<return type="Texture2D">
 			</return>
 			<description>
+				Override this method in your plugin to return a [Texture2D] in order to give it an icon.
+				For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons.
+				Ideally, the plugin icon should be white with a transparent background and 16x16 pixels in size.
+				[codeblock]
+				func get_plugin_icon():
+				    # You can use a custom icon:
+				    return preload("res://addons/my_plugin/my_plugin_icon.svg")
+				    # Or use a built-in icon:
+				    return get_editor_interface().get_base_control().get_icon("Node", "EditorIcons")
+				[/codeblock]
 			</description>
 		</method>
 		<method name="get_plugin_name" qualifiers="virtual">
 			<return type="String">
 			</return>
 			<description>
+				Override this method in your plugin to provide the name of the plugin when displayed in the Godot editor.
+				For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons.
 			</description>
 		</method>
 		<method name="get_script_create_dialog">
-- 
cgit v1.2.3