diff --git a/tutorials/export/feature_tags.rst b/tutorials/export/feature_tags.rst index 45c1d7c7e..19d7429d4 100644 --- a/tutorials/export/feature_tags.rst +++ b/tutorials/export/feature_tags.rst @@ -188,6 +188,28 @@ in many sections of the project settings. .. image:: img/feature_tags4.webp +Taking feature tags into account when reading project settings +-------------------------------------------------------------- + +By default, feature tags are **not** taken into account when reading project settings +using the typical approaches (:ref:`ProjectSettings.get_setting` +or :ref:`ProjectSettings.get `). +Instead, you must use :ref:`ProjectSettings.get_setting_with_override `. + +For example, with the following project settings: + +:: + + [section] + + subsection/example = "Release" + subsection/example.debug = "Debug" + +Using ``ProjectSettings.get_setting("section/subsection/example")`` will return +``"Release"`` regardless of whether a debug build is currently running. On the +other hand, ``ProjectSettings.get_setting_with_override("section/subsection/example")`` +will obey feature tags and will return ``"Debug"`` if using a debug build. + Customizing the build ---------------------