{"name":"Title Effect Type","title":"Title Effect Type","type":"topic","url":"https://community.bistudio.com/wiki/Title_Effect_Type","revid":341304,"updated":"2023-05-20T20:48:07Z","aliases":[],"markdown":"A Title Effect Type is a String parameter that is required by a few scripting commands.\nThe commands are used to display custom GUI elements on the front end or the back end.\n\nSix commands use this parameter:\n\n| cut* commands | title* commands |\n|---|---|\n| - cutObj<br>- cutRsc<br>- cutText | - titleObj<br>- titleRsc<br>- titleText |\n\n> [!NOTE]\n> 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.\n> If a layer is not specified, the cut effects will be defaulted to layer 0.\n\nThe **Title Effect** simply tells the game engine how to display the object, resource, or text that is passed to the command.\nIf plain text is given, it is always white with a black shadow and horizontally centered.\nThe different effects are described below - the effects may vary if a black or white 'curtain' is currently visible or not:\n\n| Colour | Type | Description |\n|---|---|---|\n| N/A | \"PLAIN\" | Displays the text, object, or resource given. Plain text is vertically centered. |\n| N/A | \"PLAIN NOFADE\" | Displays the text, object, or resource given. Plain text is vertically centered. Has no fade in and fade out. |\n| N/A | \"PLAIN DOWN\" | Displays the text, object, or resource given. Plain text is vertically aligned to 25% from the bottom of the screen. |\n|  | \"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'.<br>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. |\n|  | \"WHITE IN\" | Withdraws a white 'curtain' revealing the GUI. |\n|  | \"BLACK\" | Same as \"BLACK OUT\". |\n|  | \"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'.<br>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. |\n|  | \"BLACK OUT\" | 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'. |\n|  | \"BLACK IN\" | Reveals the GUI after a black 'curtain' is withdrawn along with the optional text, object, or resource that was given. |","sections":[{"heading":null,"level":1,"markdown":"A Title Effect Type is a String parameter that is required by a few scripting commands.\nThe commands are used to display custom GUI elements on the front end or the back end.\n\nSix commands use this parameter:\n\n| cut* commands | title* commands |\n|---|---|\n| - cutObj<br>- cutRsc<br>- cutText | - titleObj<br>- titleRsc<br>- titleText |\n\n> [!NOTE]\n> 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.\n> If a layer is not specified, the cut effects will be defaulted to layer 0.\n\nThe **Title Effect** simply tells the game engine how to display the object, resource, or text that is passed to the command.\nIf plain text is given, it is always white with a black shadow and horizontally centered.\nThe different effects are described below - the effects may vary if a black or white 'curtain' is currently visible or not:\n\n| Colour | Type | Description |\n|---|---|---|\n| N/A | \"PLAIN\" | Displays the text, object, or resource given. Plain text is vertically centered. |\n| N/A | \"PLAIN NOFADE\" | Displays the text, object, or resource given. Plain text is vertically centered. Has no fade in and fade out. |\n| N/A | \"PLAIN DOWN\" | Displays the text, object, or resource given. Plain text is vertically aligned to 25% from the bottom of the screen. |\n|  | \"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'.<br>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. |\n|  | \"WHITE IN\" | Withdraws a white 'curtain' revealing the GUI. |\n|  | \"BLACK\" | Same as \"BLACK OUT\". |\n|  | \"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'.<br>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. |\n|  | \"BLACK OUT\" | 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'. |\n|  | \"BLACK IN\" | Reveals the GUI after a black 'curtain' is withdrawn along with the optional text, object, or resource that was given. |"}],"categories":["Reference Lists"],"groups":["Reference Lists"]}