Skip to content

Commit 828d299

Browse files
authored
Merge pull request #11301 from Calinou/upgrading-to-godot-4.5-projectsettings-usage
Mention new warnings for `ProjectSettings.add_property_info()` in Upgrading to Godot 4.5
2 parents 2778124 + 7d28b53 commit 828d299

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

tutorials/migrating/upgrading_to_godot_4.5.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,17 @@ new behavior, you must change the "Naming Version" option at the bottom of the I
204204
Core
205205
~~~~
206206

207+
.. note::
208+
209+
:ref:`ProjectSettings.add_property_info() <class_ProjectSettings_method_add_property_info>`
210+
now prints a warning when the dictionary parameter has missing keys or invalid keys.
211+
Most importantly, it will now warn when a ``usage`` key is passed, as this key is not used.
212+
This was also the case before 4.5, but it was silently ignored instead.
213+
As a reminder, to set property usage information correctly, you must use
214+
:ref:`ProjectSettings.set_as_basic() <class_ProjectSettings_method_set_as_basic>`,
215+
:ref:`ProjectSettings.set_restart_if_changed() <class_ProjectSettings_method_set_restart_if_changed>`,
216+
or :ref:`ProjectSettings.set_as_internal() <class_ProjectSettings_method_set_as_internal>` instead.
217+
207218
.. note::
208219

209220
In C#, ``StringExtensions.PathJoin`` now avoids adding an extra path separator when the original string is empty,

0 commit comments

Comments
 (0)