Title Effect Type

From Bohemia Interactive Community
Jump to navigation Jump to search

A Title Effect Type is a String parameter that is required by a few scripting commands. The commands are used to display custom GUI elements on the front end or the back end. Six commands use this parameter:

cut* commands title* commands
The main difference between these commands is that title* commands can only have a single effect on a single title layer, whereas the cut* ones allow to have multiple effects on multiple cut layers. If a layer is not specified, the cut effects will be defaulted to layer 0.

The Title Effect simply tells the game engine how to display the object, resource, or text that is passed to the command. If plain text is given, it is always white with a black shadow and horizontally centered. The different effects are described below - the effects may vary if a black or white 'curtain' is currently visible or not:

Type Description
"PLAIN" Displays the text, object, or resource given. Plain text is vertically centered.
"PLAIN NOFADE" Displays the text, object, or resource given. Plain text is vertically centered. Has no fade in and fade out.
"PLAIN DOWN" Displays the text, object, or resource given. Plain text is vertically aligned to 25% from the bottom of the screen.
"BLACK" Causes the screen to turn completely black, and displays the optional text, object, or resource given. All other GUI is hidden behind this black 'curtain'.
"BLACK FADED" Causes the screen to turn completely black without fading in, and displays the optional text, object, or resource given. All other GUI is hidden behind this black 'curtain'. If a 'speed' is not given, the 'curtain' and the displayed element disappears instantly after 5-10 seconds. Otherwise it will stay black with the element still visible.
"BLACK OUT" Same as "BLACK".
"BLACK IN" Reveals the GUI after a black 'curtain' is withdrawn along with the optional text, object, or resource that was given.
"WHITE OUT" Causes the screen to turn completely white, and displays the optional text, object, or resource given. All other GUI is hidden behind this white 'curtain'. This can easily blind the player so it should be used with caution. Make sure that a fade-in time is set when calling the command.
"WHITE IN" Withdraws a white 'curtain' revealing the GUI.