Andrew/redot-engine
1
0
Fork 0
mirror of https://github.com/Redot-Engine/redot-engine.git synced 2025-12-06 07:17:42 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #104530 from RedMser/accept-dialog-custom-action-docs

Browse Source 
Clarify that AcceptDialog's `custom_action` is only triggered if action is non-empty
This commit is contained in:
Thaddeus Crews
2025-06-18 18:13:55 -05:00
parent 935fcd1675 d10e578a5d
commit a07ea48f64
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/classes/AcceptDialog.xml
View File

@@ -15,7 +15,8 @@
<param index="1" name="right" type="bool" default="false" /> <param index="1" name="right" type="bool" default="false" />
<param index="2" name="action" type="String" default="&quot;&quot;" /> <param index="2" name="action" type="String" default="&quot;&quot;" />
<description> <description>
Adds a button with label [param text] and a custom [param action] to the dialog and returns the created button. [param action] will be passed to the [signal custom_action] signal when pressed. Adds a button with label [param text] and a custom [param action] to the dialog and returns the created button.
If [param action] is not empty, pressing the button will emit the [signal custom_action] signal with the specified action string.
If [code]true[/code], [param right] will place the button to the right of any sibling buttons. If [code]true[/code], [param right] will place the button to the right of any sibling buttons.
You can use [method remove_button] method to remove a button created with this method from the dialog. You can use [method remove_button] method to remove a button created with this method from the dialog.
</description> </description>
@@ -97,7 +98,7 @@
<signal name="custom_action"> <signal name="custom_action">
<param index="0" name="action" type="StringName" /> <param index="0" name="action" type="StringName" />
<description> <description>
Emitted when a custom button is pressed. See [method add_button]. Emitted when a custom button with an action is pressed. See [method add_button].
</description> </description>
</signal> </signal>
</signals> </signals>