cutText: Difference between revisions

Revision as of 10:22, 13 May 2022

Hover & click on the images for 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.74 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.58
Groups:: GUI Control

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.
since 0.50: showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened
since 1.74: isStructuredText: Boolean - (Optional, default false) true to switch support for Structured Text formatting - see Example 4
Return Value:: Nothing

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.
since 0.50: showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened
since 1.74: isStructuredText: Boolean - (Optional, default false) true to switch support for Structured Text formatting - see Example 4
Return Value:: Nothing

Syntax:: layerName cutText [text, type, speed, showInMap, isStructuredText]
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
since 1.74: isStructuredText: Boolean - (Optional, default false) true to switch support for Structured Text formatting - see Example 4
Return Value:: Number - number of the allocated layer

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

See also:: allCutLayers titleText cutRsc cutObj cutFadeOut allActiveTitleEffects activeTitleEffectParams

: 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

: 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)

@@ Line 83: / Line 83: @@
 |r3= [[Number]] - number of the allocated layer
-|x1= <code>cutText ["", "BLACK OUT"];
+|x1= <sqf>cutText ["", "BLACK OUT"];
-cutText ["Hello World!", "PLAIN", 2];</code>
+cutText ["Hello World!", "PLAIN", 2];</sqf>
-|x2= <code>2 cutText ["Hello World!", "PLAIN", 2];</code>
+|x2= <sqf>2 cutText ["Hello World!", "PLAIN", 2];</sqf>
-|x3= <code>_layer1 = "normal" cutText ["In The Centre", "PLAIN"];
+|x3= <sqf>_layer1 = "normal" cutText ["In The Centre", "PLAIN"];
-_layer2 = "down" cutText ["At The Bottom", "PLAIN DOWN"];</code>
+_layer2 = "down" cutText ["At The Bottom", "PLAIN DOWN"];</sqf>
-|x4= <code>cutText ["&lt;t color='#ff0000' size='5'>RED ALERT!&lt;/t>&lt;br/>***********", "PLAIN", -1, true, true];</code>
+|x4= <sqf>cutText ["&lt;t color='#ff0000' size='5'>RED ALERT!&lt;/t>&lt;br/>***********", "PLAIN", -1, true, true];</sqf>
 |seealso= [[allCutLayers]] [[titleText]] [[cutRsc]] [[cutObj]] [[cutFadeOut]] [[allActiveTitleEffects]] [[activeTitleEffectParams]]