Skip to content

Commit 9abcbd7

Browse files
authored
Merge pull request #10515 from elpozewaunig/splash-properties
Document $GODOT_SPLASH_CLASSES placeholder for custom HTML5 shells
2 parents fad4662 + c2ea3ae commit 9abcbd7

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

tutorials/platform/web/customizing_html5_shell.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,20 @@ The following optional placeholders will enable some extra features in your cust
8383
:ref:`BG Color <class_ProjectSettings_property_application/boot_splash/bg_color>` setting
8484
in **Project Settings > Application > Boot Splash**, converted to a hex color code.
8585

86+
- ``$GODOT_SPLASH_CLASSES``:
87+
This placeholder provides a string of setting names and their values, which affect the splash screen.
88+
This string is meant to be used as a set of CSS class names, which allows styling the splash image
89+
based on the splash project settings.
90+
The following settings from **Project Settings > Application > Boot Splash** are provided,
91+
represented by the class names shown below depending on the setting's boolean value:
92+
93+
- :ref:`Show Image <class_ProjectSettings_property_application/boot_splash/show_image>`:
94+
``show-image--true``, ``show-image--false``
95+
- :ref:`Fullsize <class_ProjectSettings_property_application/boot_splash/fullsize>`:
96+
``fullsize--true``, ``fullsize--false``
97+
- :ref:`Use Filter <class_ProjectSettings_property_application/boot_splash/use_filter>`:
98+
``use-filter--true``, ``use-filter--false``
99+
86100
When the custom page is ready, it can be selected in the export options under the *Html / Custom Html Shell*
87101
section.
88102

0 commit comments

Comments
 (0)