seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[doc] Use "param" instead of "code" to refer to parameters (4)

Browse Source
This commit is contained in:
Andy Maloney
2022-08-11 13:52:19 -04:00
parent ad247899ab
commit 1df86ecea5
34 changed files with 209 additions and 209 deletions
Download Patch File Download Diff File Expand all files Collapse all files

120
doc/classes/PopupMenu.xml
View File

@ -19,8 +19,8 @@
<param index="1" name="id" type="int" default="-1" />
<param index="2" name="accel" type="int" enum="Key" default="0" />
<description>
Adds a new checkable item with text [code]label[/code].
An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
Adds a new checkable item with text [param label].
An [param id] can optionally be provided, as well as an accelerator ([param accel]). If no [param id] is provided, one will be created from the index. If no [param accel] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
[b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it.
</description>
</method>
@ -31,7 +31,7 @@
<param index="2" name="global" type="bool" default="false" />
<description>
Adds a new checkable item and assigns the specified [Shortcut] to it. Sets the label of the checkbox to the [Shortcut]'s name.
An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index.
An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index.
[b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it.
</description>
</method>
@ -42,8 +42,8 @@
<param index="2" name="id" type="int" default="-1" />
<param index="3" name="accel" type="int" enum="Key" default="0" />
<description>
Adds a new checkable item with text [code]label[/code] and icon [code]texture[/code].
An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
Adds a new checkable item with text [param label] and icon [param texture].
An [param id] can optionally be provided, as well as an accelerator ([param accel]). If no [param id] is provided, one will be created from the index. If no [param accel] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
[b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it.
</description>
</method>
@ -54,8 +54,8 @@
<param index="2" name="id" type="int" default="-1" />
<param index="3" name="global" type="bool" default="false" />
<description>
Adds a new checkable item and assigns the specified [Shortcut] and icon [code]texture[/code] to it. Sets the label of the checkbox to the [Shortcut]'s name.
An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index.
Adds a new checkable item and assigns the specified [Shortcut] and icon [param texture] to it. Sets the label of the checkbox to the [Shortcut]'s name.
An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index.
[b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it.
</description>
</method>
@ -66,8 +66,8 @@
<param index="2" name="id" type="int" default="-1" />
<param index="3" name="accel" type="int" enum="Key" default="0" />
<description>
Adds a new item with text [code]label[/code] and icon [code]texture[/code].
An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
Adds a new item with text [param label] and icon [param texture].
An [param id] can optionally be provided, as well as an accelerator ([param accel]). If no [param id] is provided, one will be created from the index. If no [param accel] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
</description>
</method>
<method name="add_icon_radio_check_item">
@ -97,8 +97,8 @@
<param index="2" name="id" type="int" default="-1" />
<param index="3" name="global" type="bool" default="false" />
<description>
Adds a new item and assigns the specified [Shortcut] and icon [code]texture[/code] to it. Sets the label of the checkbox to the [Shortcut]'s name.
An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index.
Adds a new item and assigns the specified [Shortcut] and icon [param texture] to it. Sets the label of the checkbox to the [Shortcut]'s name.
An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index.
</description>
</method>
<method name="add_item">
@ -107,9 +107,9 @@
<param index="1" name="id" type="int" default="-1" />
<param index="2" name="accel" type="int" enum="Key" default="0" />
<description>
Adds a new item with text [code]label[/code].
An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
[b]Note:[/b] The provided [code]id[/code] is used only in [signal id_pressed] and [signal id_focused] signals. It's not related to the [code]index[/code] arguments in e.g. [method set_item_checked].
Adds a new item with text [param label].
An [param id] can optionally be provided, as well as an accelerator ([param accel]). If no [param id] is provided, one will be created from the index. If no [param accel] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
[b]Note:[/b] The provided [param id] is used only in [signal id_pressed] and [signal id_focused] signals. It's not related to the [code]index[/code] arguments in e.g. [method set_item_checked].
</description>
</method>
<method name="add_multistate_item">
@ -120,9 +120,9 @@
<param index="3" name="id" type="int" default="-1" />
<param index="4" name="accel" type="int" enum="Key" default="0" />
<description>
Adds a new multistate item with text [code]label[/code].
Contrarily to normal binary items, multistate items can have more than two states, as defined by [code]max_states[/code]. Each press or activate of the item will increase the state by one. The default value is defined by [code]default_state[/code].
An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
Adds a new multistate item with text [param label].
Contrarily to normal binary items, multistate items can have more than two states, as defined by [param max_states]. Each press or activate of the item will increase the state by one. The default value is defined by [param default_state].
An [param id] can optionally be provided, as well as an accelerator ([param accel]). If no [param id] is provided, one will be created from the index. If no [param accel] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
</description>
</method>
<method name="add_radio_check_item">
@ -131,8 +131,8 @@
<param index="1" name="id" type="int" default="-1" />
<param index="2" name="accel" type="int" enum="Key" default="0" />
<description>
Adds a new radio check button with text [code]label[/code].
An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
Adds a new radio check button with text [param label].
An [param id] can optionally be provided, as well as an accelerator ([param accel]). If no [param id] is provided, one will be created from the index. If no [param accel] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators.
[b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it.
</description>
</method>
@ -143,7 +143,7 @@
<param index="2" name="global" type="bool" default="false" />
<description>
Adds a new radio check button and assigns a [Shortcut] to it. Sets the label of the checkbox to the [Shortcut]'s name.
An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index.
An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index.
[b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method set_item_checked] for more info on how to control it.
</description>
</method>
@ -152,8 +152,8 @@
<param index="0" name="label" type="String" default="&quot;&quot;" />
<param index="1" name="id" type="int" default="-1" />
<description>
Adds a separator between items. Separators also occupy an index, which you can set by using the [code]id[/code] parameter.
A [code]label[/code] can optionally be provided, which will appear at the center of the separator.
Adds a separator between items. Separators also occupy an index, which you can set by using the [param id] parameter.
A [param label] can optionally be provided, which will appear at the center of the separator.
</description>
</method>
<method name="add_shortcut">
@ -163,7 +163,7 @@
<param index="2" name="global" type="bool" default="false" />
<description>
Adds a [Shortcut].
An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index.
An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index.
</description>
</method>
<method name="add_submenu_item">
@ -172,8 +172,8 @@
<param index="1" name="submenu" type="String" />
<param index="2" name="id" type="int" default="-1" />
<description>
Adds an item that will act as a submenu of the parent [PopupMenu] node when clicked. The [code]submenu[/code] argument is the name of the child [PopupMenu] node that will be shown when the item is clicked.
An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index.
Adds an item that will act as a submenu of the parent [PopupMenu] node when clicked. The [param submenu] argument is the name of the child [PopupMenu] node that will be shown when the item is clicked.
An [param id] can optionally be provided. If no [param id] is provided, one will be created from the index.
</description>
</method>
<method name="clear">
@ -192,35 +192,35 @@
<return type="int" enum="Key" />
<param index="0" name="index" type="int" />
<description>
Returns the accelerator of the item at the given [code]index[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused.
Returns the accelerator of the item at the given [param index]. Accelerators are special combinations of keys that activate the item, no matter which control is focused.
</description>
</method>
<method name="get_item_horizontal_offset" qualifiers="const">
<return type="int" />
<param index="0" name="index" type="int" />
<description>
Returns the horizontal offset of the item at the given [code]index[/code].
Returns the horizontal offset of the item at the given [param index].
</description>
</method>
<method name="get_item_icon" qualifiers="const">
<return type="Texture2D" />
<param index="0" name="index" type="int" />
<description>
Returns the icon of the item at the given [code]index[/code].
Returns the icon of the item at the given [param index].
</description>
</method>
<method name="get_item_id" qualifiers="const">
<return type="int" />
<param index="0" name="index" type="int" />
<description>
Returns the id of the item at the given [code]index[/code]. [code]id[/code] can be manually assigned, while index can not.
Returns the id of the item at the given [param index]. [code]id[/code] can be manually assigned, while index can not.
</description>
</method>
<method name="get_item_index" qualifiers="const">
<return type="int" />
<param index="0" name="id" type="int" />
<description>
Returns the index of the item containing the specified [code]id[/code]. Index is automatically assigned to each item by the engine and can not be set manually.
Returns the index of the item containing the specified [param id]. Index is automatically assigned to each item by the engine and can not be set manually.
</description>
</method>
<method name="get_item_language" qualifiers="const">
@ -241,21 +241,21 @@
<return type="Shortcut" />
<param index="0" name="index" type="int" />
<description>
Returns the [Shortcut] associated with the item at the given [code]index[/code].
Returns the [Shortcut] associated with the item at the given [param index].
</description>
</method>
<method name="get_item_submenu" qualifiers="const">
<return type="String" />
<param index="0" name="index" type="int" />
<description>
Returns the submenu name of the item at the given [code]index[/code]. See [method add_submenu_item] for more info on how to add a submenu.
Returns the submenu name of the item at the given [param index]. See [method add_submenu_item] for more info on how to add a submenu.
</description>
</method>
<method name="get_item_text" qualifiers="const">
<return type="String" />
<param index="0" name="index" type="int" />
<description>
Returns the text of the item at the given [code]index[/code].
Returns the text of the item at the given [param index].
</description>
</method>
<method name="get_item_text_direction" qualifiers="const">
@ -269,14 +269,14 @@
<return type="String" />
<param index="0" name="index" type="int" />
<description>
Returns the tooltip associated with the item at the given [code]index[/code].
Returns the tooltip associated with the item at the given [param index].
</description>
</method>
<method name="is_item_checkable" qualifiers="const">
<return type="bool" />
<param index="0" name="index" type="int" />
<description>
Returns [code]true[/code] if the item at the given [code]index[/code] is checkable in some way, i.e. if it has a checkbox or radio button.
Returns [code]true[/code] if the item at the given [param index] is checkable in some way, i.e. if it has a checkbox or radio button.
[b]Note:[/b] Checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually.
</description>
</method>
@ -284,14 +284,14 @@
<return type="bool" />
<param index="0" name="index" type="int" />
<description>
Returns [code]true[/code] if the item at the given [code]index[/code] is checked.
Returns [code]true[/code] if the item at the given [param index] is checked.
</description>
</method>
<method name="is_item_disabled" qualifiers="const">
<return type="bool" />
<param index="0" name="index" type="int" />
<description>
Returns [code]true[/code] if the item at the given [code]index[/code] is disabled. When it is disabled it can't be selected, or its action invoked.
Returns [code]true[/code] if the item at the given [param index] is disabled. When it is disabled it can't be selected, or its action invoked.
See [method set_item_disabled] for more info on how to disable an item.
</description>
</method>
@ -299,7 +299,7 @@
<return type="bool" />
<param index="0" name="index" type="int" />
<description>
Returns [code]true[/code] if the item at the given [code]index[/code] has radio button-style checkability.
Returns [code]true[/code] if the item at the given [param index] has radio button-style checkability.
[b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
</description>
</method>
@ -321,7 +321,7 @@
<return type="void" />
<param index="0" name="index" type="int" />
<description>
Removes the item at the given [code]index[/code] from the menu.
Removes the item at the given [param index] from the menu.
[b]Note:[/b] The indices of items after the removed item will be shifted by one.
</description>
</method>
@ -329,14 +329,14 @@
<return type="void" />
<param index="0" name="index" type="int" />
<description>
Moves the scroll view to make the item at the given [code]index[/code] visible.
Moves the scroll view to make the item at the given [param index] visible.
</description>
</method>
<method name="set_current_index">
<return type="void" />
<param index="0" name="index" type="int" />
<description>
Sets the currently focused item as the given [code]index[/code].
Sets the currently focused item as the given [param index].
</description>
</method>
<method name="set_item_accelerator">
@ -344,7 +344,7 @@
<param index="0" name="index" type="int" />
<param index="1" name="accel" type="int" enum="Key" />
<description>
Sets the accelerator of the item at the given [code]index[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused.
Sets the accelerator of the item at the given [param index]. Accelerators are special combinations of keys that activate the item, no matter which control is focused.
</description>
</method>
<method name="set_item_as_checkable">
@ -352,7 +352,7 @@
<param index="0" name="index" type="int" />
<param index="1" name="enable" type="bool" />
<description>
Sets whether the item at the given [code]index[/code] has a checkbox. If [code]false[/code], sets the type of the item to plain text.
Sets whether the item at the given [param index] has a checkbox. If [code]false[/code], sets the type of the item to plain text.
[b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually.
</description>
</method>
@ -361,7 +361,7 @@
<param index="0" name="index" type="int" />
<param index="1" name="enable" type="bool" />
<description>
Sets the type of the item at the given [code]index[/code] to radio button. If [code]false[/code], sets the type of the item to plain text.
Sets the type of the item at the given [param index] to radio button. If [code]false[/code], sets the type of the item to plain text.
</description>
</method>
<method name="set_item_as_separator">
@ -369,7 +369,7 @@
<param index="0" name="index" type="int" />
<param index="1" name="enable" type="bool" />
<description>
Mark the item at the given [code]index[/code] as a separator, which means that it would be displayed as a line. If [code]false[/code], sets the type of the item to plain text.
Mark the item at the given [param index] as a separator, which means that it would be displayed as a line. If [code]false[/code], sets the type of the item to plain text.
</description>
</method>
<method name="set_item_checked">
@ -377,7 +377,7 @@
<param index="0" name="index" type="int" />
<param index="1" name="checked" type="bool" />
<description>
Sets the checkstate status of the item at the given [code]index[/code].
Sets the checkstate status of the item at the given [param index].
</description>
</method>
<method name="set_item_disabled">
@ -385,7 +385,7 @@
<param index="0" name="index" type="int" />
<param index="1" name="disabled" type="bool" />
<description>
Enables/disables the item at the given [code]index[/code]. When it is disabled, it can't be selected and its action can't be invoked.
Enables/disables the item at the given [param index]. When it is disabled, it can't be selected and its action can't be invoked.
</description>
</method>
<method name="set_item_horizontal_offset">
@ -393,7 +393,7 @@
<param index="0" name="index" type="int" />
<param index="1" name="offset" type="int" />
<description>
Sets the horizontal offset of the item at the given [code]index[/code].
Sets the horizontal offset of the item at the given [param index].
</description>
</method>
<method name="set_item_icon">
@ -401,7 +401,7 @@
<param index="0" name="index" type="int" />
<param index="1" name="icon" type="Texture2D" />
<description>
Replaces the [Texture2D] icon of the item at the given [code]index[/code].
Replaces the [Texture2D] icon of the item at the given [param index].
</description>
</method>
<method name="set_item_id">
@ -409,8 +409,8 @@
<param index="0" name="index" type="int" />
<param index="1" name="id" type="int" />
<description>
Sets the [code]id[/code] of the item at the given [code]index[/code].
The [code]id[/code] is used in [signal id_pressed] and [signal id_focused] signals.
Sets the [param id] of the item at the given [param index].
The [param id] is used in [signal id_pressed] and [signal id_focused] signals.
</description>
</method>
<method name="set_item_language">
@ -443,7 +443,7 @@
<param index="1" name="shortcut" type="Shortcut" />
<param index="2" name="global" type="bool" default="false" />
<description>
Sets a [Shortcut] for the item at the given [code]index[/code].
Sets a [Shortcut] for the item at the given [param index].
</description>
</method>
<method name="set_item_shortcut_disabled">
@ -451,7 +451,7 @@
<param index="0" name="index" type="int" />
<param index="1" name="disabled" type="bool" />
<description>
Disables the [Shortcut] of the item at the given [code]index[/code].
Disables the [Shortcut] of the item at the given [param index].
</description>
</method>
<method name="set_item_submenu">
@ -459,7 +459,7 @@
<param index="0" name="index" type="int" />
<param index="1" name="submenu" type="String" />
<description>
Sets the submenu of the item at the given [code]index[/code]. The submenu is the name of a child [PopupMenu] node that would be shown when the item is clicked.
Sets the submenu of the item at the given [param index]. The submenu is the name of a child [PopupMenu] node that would be shown when the item is clicked.
</description>
</method>
<method name="set_item_text">
@ -467,7 +467,7 @@
<param index="0" name="index" type="int" />
<param index="1" name="text" type="String" />
<description>
Sets the text of the item at the given [code]index[/code].
Sets the text of the item at the given [param index].
</description>
</method>
<method name="set_item_text_direction">
@ -483,14 +483,14 @@
<param index="0" name="index" type="int" />
<param index="1" name="tooltip" type="String" />
<description>
Sets the [String] tooltip of the item at the given [code]index[/code].
Sets the [String] tooltip of the item at the given [param index].
</description>
</method>
<method name="toggle_item_checked">
<return type="void" />
<param index="0" name="index" type="int" />
<description>
Toggles the check state of the item at the given [code]index[/code].
Toggles the check state of the item at the given [param index].
</description>
</method>
<method name="toggle_item_multistate">
@ -525,19 +525,19 @@
<signal name="id_focused">
<param index="0" name="id" type="int" />
<description>
Emitted when user navigated to an item of some [code]id[/code] using [code]ui_up[/code] or [code]ui_down[/code] action.
Emitted when user navigated to an item of some [param id] using [code]ui_up[/code] or [code]ui_down[/code] action.
</description>
</signal>
<signal name="id_pressed">
<param index="0" name="id" type="int" />
<description>
Emitted when an item of some [code]id[/code] is pressed or its accelerator is activated.
Emitted when an item of some [param id] is pressed or its accelerator is activated.
</description>
</signal>
<signal name="index_pressed">
<param index="0" name="index" type="int" />
<description>
Emitted when an item of some [code]index[/code] is pressed or its accelerator is activated.
Emitted when an item of some [param index] is pressed or its accelerator is activated.
</description>
</signal>
</signals>