cutText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
Line 12: Line 12:
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''cutText''' [text,type,speed] |= Syntax
| '''cutText''' [text,type,speed,showOnMap] |= Syntax
|p1= text: [[String]] - text to be displayed |= Parameter 1
|p1= text: [[String]] - text to be displayed |= Parameter 1
|p2= type: [[String]] one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See [[Title Effect Type]]s for more information about these values. |= Parameter 2
|p2= type: [[String]] one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See [[Title Effect Type]]s for more information about these values. |= Parameter 2
|p3= speed: [[Number]] - Time in seconds to fade in resource (optional, default: 1) |= Parameter 3
|p3= speed: [[Number]] - Time in seconds to fade in resource (optional, default: 1) |= Parameter 3
|p4= showOnMap: [[Boolean]] - [[false]] to hide the text when the map is opened (''Introduced in {{arma3}}''). |=
| [[Nothing]] |= Return value
| [[Nothing]] |= Return value


|s2= layer '''cutText''' [text,type,speed] (''Only available in Arma 2 or VBS2 (1.30+).'')|= Syntax
|s2= layer '''cutText''' [text,type,speed,showOnMap] (''Introduced in Arma 2 / VBS2 (1.30+).'')|= Syntax
|p21= layer: [[Number]] - Defines the layer in which the effect is shown, where 0 is the backmost one. |= Parameter 1
|p21= layer: [[Number]] - Defines the layer in which the effect is shown, where 0 is the backmost one. |= Parameter 1
|p22= text: [[String]] - text to be displayed |= Parameter 2
|p22= text: [[String]] - text to be displayed |= Parameter 2
|p23= type: [[String]] one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See [[Title Effect Type]]s for more information about these values. |= Parameter 3
|p23= type: [[String]] one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See [[Title Effect Type]]s for more information about these values. |= Parameter 3
|p24= speed: [[Number]] - Time in seconds to fade in resource (optional, default: 1) |= Parameter 4
|p24= speed: [[Number]] - Time in seconds to fade in resource (optional, default: 1) |= Parameter 4
|p25= showOnMap: [[Boolean]] - [[false]] to hide the text when the map is opened (''Introduced in {{arma3}}''). |=
|r2= [[Nothing]] |= Return value
|r2= [[Nothing]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________

Revision as of 08:53, 3 July 2013

Hover & click on the images for description

Description

Description:
Displays a text message in the center of the screen.
Groups:
Uncategorised

Syntax

Syntax:
cutText [text,type,speed,showOnMap]
Parameters:
text: String - text to be displayed
type: String one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See Title Effect Types for more information about these values.
speed: Number - Time in seconds to fade in resource (optional, default: 1)
showOnMap: Boolean - false to hide the text when the map is opened (Introduced in Arma 3).
Return Value:
Nothing

Alternative Syntax

Syntax:
layer cutText [text,type,speed,showOnMap] (Introduced in Arma 2 / VBS2 (1.30+).)
Parameters:
layer: Number - Defines the layer in which the effect is shown, where 0 is the backmost one.
text: String - text to be displayed
type: String one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See Title Effect Types for more information about these values.
speed: Number - Time in seconds to fade in resource (optional, default: 1)
showOnMap: Boolean - false to hide the text when the map is opened (Introduced in Arma 3).
Return Value:
Nothing

Examples

Example 1:
cutText ["","BLACK OUT"]
cutText ["Hello World!","PLAIN",2]
Example 2:
2 cutText ["Hello World!","PLAIN",2];

Additional Information

See also:
titleTextcutRsccutObj

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Notes

Bottom Section