cutText

1.00

LELocal

Hover & click on the images for description

Description

Description:

Displays a text message in the center of the screen. The text can be displayed on multiple lines by using "\n" new line characters:
cutText ["line1\nline2\nline3", "PLAIN"];

Since Arma 3 v1.57.134673 it is possible to allocate layers by passing layer name as parameter.

Groups:

Uncategorised

Syntax 1

Syntax:

cutText [text, type, speed, showOnMap]

Parameters:

[text, type, speed, showOnMap]: Array

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

Syntax 2

Syntax:

layer cutText [text, type, speed, showOnMap] (Introduced in Arma 2 / VBS2 (1.30+).)

Parameters:

layer: Number - layer number on which the effect is shown, where 0 is the back most. Layer number is rounded to the nearest integer and also cannot be negative. Layer 99.5 will be treated as layer 100.

[text, type, speed, showOnMap]: Array

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

Syntax 3

Syntax:

layerName cutText [text, type, speed, showOnMap]        (Since Arma 3 v1.57.134673)

Parameters:

layerName: String - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE

[text, type, speed, showOnMap]: Array

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:

Number - number of the allocated layer

Examples

Example 1:

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

Example 2:

2 cutText ["Hello World!","PLAIN",2];

Example 3:

_layer1 = "normal" cutText ["In The Centre","PLAIN"]; _layer2 = "down" cutText ["At The Bottom","PLAIN DOWN"];

Additional Information

See also:

titleTextcutRsccutObjcutFadeOut

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

Posted on September 20, 2013 - 06:59

Killzone_Kid

In Arma 3 "PLAIN" param will display your text where the crosshair is, "PLAIN DOWN" will push the text further down, closer to the bottom of the screen.