cutText

Local effect
Arma 3 v0.50
First in Operation Flashpoint v1.00

Command · Markdown · JSON · original wiki page

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

Note
Arma 3: For greater efficiency and ease of modability it is recommended to use named layers through the alternative syntax.

Syntax

Syntax 1

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

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. If 0 or less, default value is used
showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened (since arma3 0.50)
isStructuredText: Boolean - (Optional, default false) true to switch support for Structured Text formatting - see #Example 4 (since arma3 1.74)
drawOverHUD: Boolean - (Optional, default true) false to show the text under in-game HUD (since arma3 2.16)

Returns: Nothing

Syntax 2

since arma3 1.58

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

Parameters:

layer: Number or String
- 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.
- 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. If 0 or less, default value is used
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 (since arma3 1.74)
drawOverHUD: Boolean - (Optional, default true) false to show the text under in-game HUD (since arma3 2.16)

Returns: - Nothing when layer is a Number

Number when ''layer is a String

Examples

Example 1

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

Example 2

2 cutText ["Hello World!", "PLAIN", 2]; // returns nothing

Example 3

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

Example 4

cutText ["<t color='#ff0000' size='5'>RED ALERT!</t><br/>***********", "PLAIN", -1, true, true];