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.73.142260 this command supports Structured Text formatting.

For greater efficiency and ease of modability it is recommended to use named layers available with alternative syntax since Arma 3 v1.57.134673

Groups:

GUI Control

Syntax 1

Syntax:

cutText [text, type, speed, showInMap, isStructuredText]

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 - (Optional, default -1) time in seconds to fade in resource.

showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened. Template:Since

isStructuredText: Boolean - (Optional, default false) true to switch support for Structured Text formatting - see Example 4. Template:Since

Return Value:

Nothing

Syntax 2

Syntax:

layer cutText [text, type, speed, showInMap, isStructuredText]

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: 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 - (Optional, default -1) time in seconds to fade in resource.

showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened.

isStructuredText: Boolean - (Optional, default false) true to switch support for Structured Text formatting - see Example 4. Template:Since

Return Value:

Nothing

Syntax 3

Syntax:

layerName cutText [text, type, speed, showInMap, isStructuredText] Template:Since

Parameters:

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

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 - (Optional, default -1) Time in seconds to fade in resource.

showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened. Template:Since

isStructuredText: Boolean - (Optional, default false) true to switch support for Structured Text formatting - see Example 4. Template:Since

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"];

Example 4:

Since Arma 3 v1.73.142260:cutText ["<t color='#ff0000' size='5'>RED ALERT!</t><br/>***********", "PLAIN", -1, true, true];

Additional Information

See also:

allCutLayerstitleTextcutRsccutObjcutFadeOutallActiveTitleEffects

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.

Posted on July 6, 2016 - 13:32 (UTC)

Krzmbrzl00

The value for speed has to be greater 0. If 0 is used as speed the default value (1) will be used.
If you want to create an "instant" effect you can use a really small value (e.g. 0.001)