Title Effect Type: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added "PLAIN NOFADE" title effect type)
m (Some wiki formatting)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
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:
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 [[:Category:Scripting Commands|commands]] use this parameter:
|
 
{| style="min-width: 20em"
: {| class="wikitable" style="min-width: 20em"
! cut* commands !! title* commands
! cut* commands !! title* commands
|-
|-
Line 15: Line 16:
* [[titleText]]
* [[titleText]]
|}
|}
|
{{Informative | The main difference between these commands is that <tt>title*</tt> commands can only have a single effect on a single title layer, whereas the <tt>cut*</tt> 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:
: {{Feature|informative|
The main difference between these commands is that {{hl|title*}} commands can only have a single effect on a single title layer, whereas the {{hl|cut*}} ones allow to have multiple effects on multiple cut layers.<br>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:


{| class="bikitable" style="border: 0.33em solid #AAA"
: {| class="wikitable" style="border: 0.33em solid #AAA"
! style="with: 1em" |
! style="font-size: 0.66em" | Colour
! Type
! Type
! Description
! Description
|-
|-
|
| {{n/a}}
| "PLAIN"
| "PLAIN"
| Displays the text, object, or resource given. Plain text is vertically centered.
| Displays the text, object, or resource given. Plain text is vertically centered.
|-
|-
|
| {{n/a}}
| style="white-space: nowrap" | "PLAIN NOFADE"
| style="white-space: nowrap" | "PLAIN NOFADE"
| Displays the text, object, or resource given. Plain text is vertically centered. Has no fade in and fade out.
| Displays the text, object, or resource given. Plain text is vertically centered. Has no fade in and fade out.
|-
|-
|
| {{n/a}}
| style="white-space: nowrap" | "PLAIN DOWN"
| style="white-space: nowrap" | "PLAIN DOWN"
| Displays the text, object, or resource given. Plain text is vertically aligned to 25% from the bottom of the screen.
| Displays the text, object, or resource given. Plain text is vertically aligned to 25% from the bottom of the screen.
|-
| style="background-color: #FFF" |
| "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.
|-
| style="background-color: #FFF" |
| "WHITE IN"
| Withdraws a white 'curtain' revealing the GUI.
|-
|-
| style="background-color: #000" |
| style="background-color: #000" |
| "BLACK"
| "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'.
| Same as "BLACK OUT".
|-
|-
| style="background-color: #000" |
| style="background-color: #000" |
| "BLACK FADED"
| "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.
| 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.
|-
|-
| style="background-color: #000" |
| style="background-color: #000" |
| "BLACK OUT"
| "BLACK OUT"
| Same as "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'.
|-
|-
| style="background-color: #000" |
| style="background-color: #000" |
| "BLACK IN"
| "BLACK IN"
| Reveals the GUI after a black 'curtain' is withdrawn along with the optional text, object, or resource that was given.
| Reveals the GUI after a black 'curtain' is withdrawn along with the optional text, object, or resource that was given.
|-
| style="background-color: #FFF" |
| "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.
|-
| style="background-color: #FFF" |
| "WHITE IN"
| Withdraws a white 'curtain' revealing the GUI.
|}
|}




[[Category:Reference_Lists]]
[[Category:Reference Lists]]

Latest revision as of 22:48, 20 May 2023

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:

Colour Type Description
N/A "PLAIN" Displays the text, object, or resource given. Plain text is vertically centered.
N/A "PLAIN NOFADE" Displays the text, object, or resource given. Plain text is vertically centered. Has no fade in and fade out.
N/A "PLAIN DOWN" Displays the text, object, or resource given. Plain text is vertically aligned to 25% from the bottom of the screen.
"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.
"BLACK" Same as "BLACK OUT".
"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" 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 IN" Reveals the GUI after a black 'curtain' is withdrawn along with the optional text, object, or resource that was given.
Retrieved from "https://community.bistudio.com/wiki?title=Title_Effect_Type&oldid=341304"