From 7051685a779f2b1fa4322d6f8fbfaba71deea73f Mon Sep 17 00:00:00 2001
From: azagaya <azagaya.games@gmail.com>
Date: Mon, 28 Jan 2019 12:31:24 -0300
Subject: Fixes differences between docs and item_selected and item_focused
 signals in optionbutton

Description in docs about item_selected and item_focused signals in optionbutton is fixed to match the real behaviour. Also, get_item_index function is added.
---
 doc/classes/OptionButton.xml | 19 ++++++++++++++-----
 1 file changed, 14 insertions(+), 5 deletions(-)

(limited to 'doc/classes')

diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml
index c58c932b61..09b9167149 100644
--- a/doc/classes/OptionButton.xml
+++ b/doc/classes/OptionButton.xml
@@ -71,9 +71,18 @@
 			<argument index="0" name="idx" type="int">
 			</argument>
 			<description>
-				Return the ID of the item at index "idx".
-			</description>
-		</method>
+				Return the ID of the item at index [code]idx[/code].
+			</description>
+		</method>
+                <method name="get_item_index" qualifiers="const">
+                        <return type="int">
+                        </return>
+                        <argument index="0" name="id" type="int">
+                        </argument>
+                        <description>
+                                Return the index of the item with the given [code]id[/code].
+                        </description>
+                </method>
 		<method name="get_item_metadata" qualifiers="const">
 			<return type="Variant">
 			</return>
@@ -198,14 +207,14 @@
 			<argument index="0" name="ID" type="int">
 			</argument>
 			<description>
-				This signal is emitted when user navigated to an item using [code]ui_up[/code] or [code]ui_down[/code] action. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index).
+				This signal is emitted when user navigated to an item using [code]ui_up[/code] or [code]ui_down[/code] action. ID of the item selected is passed as argument.
 			</description>
 		</signal>
 		<signal name="item_selected">
 			<argument index="0" name="ID" type="int">
 			</argument>
 			<description>
-				This signal is emitted when the current item was changed by the user. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index).
+				This signal is emitted when the current item was changed by the user. Index of the item selected is passed as argument.
 			</description>
 		</signal>
 	</signals>
-- 
cgit v1.2.3