summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2024-01-11 17:35:14 +0100
committerRémi Verschelde <rverschelde@gmail.com>2024-01-11 17:35:14 +0100
commit50f68ed70433c88247dcbef6e5ea3784ec8042b4 (patch)
treea97db9a58a5c5fddc2450e89eac79f1791925ed5
parent7ce8a8f030aa00c62e1865b74bd61d7d411edd6e (diff)
parentd6768a17fad24e71667e49c2c4a6bc239e6d622d (diff)
downloadredot-engine-50f68ed70433c88247dcbef6e5ea3784ec8042b4.tar.gz
Merge pull request #84886 from Calinou/doc-window-resizable
Document changing the window's resizable status at runtime
-rw-r--r--doc/classes/ProjectSettings.xml4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml
index 8640879a4e..b351a6dae6 100644
--- a/doc/classes/ProjectSettings.xml
+++ b/doc/classes/ProjectSettings.xml
@@ -810,7 +810,9 @@
Main window can't be focused. No-focus window will ignore all input, except mouse clicks.
</member>
<member name="display/window/size/resizable" type="bool" setter="" getter="" default="true">
- Allows the window to be resizable by default.
+ If [code]true[/code], allows the window to be resizable by default.
+ [b]Note:[/b] This property is only read when the project starts. To change whether the window is resizable at runtime, set [member Window.unresizable] instead on the root Window, which can be retrieved using [code]get_viewport().get_window()[/code]. [member Window.unresizable] takes the opposite value of this setting.
+ [b]Note:[/b] Certain window managers can be configured to ignore the non-resizable status of a window. Do not rely on this setting as a guarantee that the window will [i]never[/i] be resizable.
[b]Note:[/b] This setting is ignored on iOS.
</member>
<member name="display/window/size/transparent" type="bool" setter="" getter="" default="false">