Merge pull request #41046 from Calinou/doc-windowdialog-exclusive

Mention caveats for `popup_exclusive` in the WindowDialog documentation
This commit is contained in:
Rémi Verschelde 2020-08-31 13:24:09 +02:00 committed by GitHub
commit 7d825e2c05
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 0 deletions

View File

@ -67,6 +67,7 @@
<members>
<member name="popup_exclusive" type="bool" setter="set_exclusive" getter="is_exclusive" default="false">
If [code]true[/code], the popup will not be hidden when a click event occurs outside of it, or when it receives the [code]ui_cancel[/code] action event.
[b]Note:[/b] Enabling this property doesn't affect the Close or Cancel buttons' behavior in dialogs that inherit from this class. As a workaround, you can use [method WindowDialog.get_close_button] or [method ConfirmationDialog.get_cancel] and hide the buttons in question by setting their [member CanvasItem.visible] property to [code]false[/code].
</member>
<member name="visible" type="bool" setter="set_visible" getter="is_visible" override="true" default="false" />
</members>