cutText: Difference between revisions

Latest revision as of 17:58, 7 November 2023

1.00

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"];
For greater efficiency and ease of modability it is recommended to use named layers through the alternative syntax.
Groups:: GUI Control

Syntax

Syntax:: 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
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
since 2.16: drawOverHUD: Boolean - (Optional, default true) false to show the text under in-game HUD
Return Value:: Nothing

1.58

Alternative Syntax

Syntax:

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

since 1.74

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

since 2.16

drawOverHUD: Boolean - (Optional, default true) false to show the text under in-game HUD

Return Value:

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

Additional Information

See also:: allCutLayers titleText cutRsc cutObj cutFadeOut allActiveTitleEffects activeTitleEffectParams

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

@@ Line 1: / Line 1: @@
-[[Category:Scripting Commands|CUTTEXT]]
+{{RV|type=command
-[[Category:Scripting Commands OFP 1.96|CUTTEXT]]
-[[Category:Scripting Commands OFP 1.46|CUTTEXT]]
-[[Category:Scripting Commands ArmA|CUTTEXT]]
+|game1= ofp
+|version1= 1.00
-<h2 style="color:#000066"> '''cutText ''effect'''''</h2>
+|game2= ofpe
+|version2= 1.00
+|game3= arma1
+|version3= 1.00
-'''Operand types:'''
+|game4= arma2
+|version4= 1.00
-'''effect:''' [[Array]]
+|game5= arma2oa
+|version5= 1.50
-'''Type of returned value:'''
+|game6= tkoh
+|version6= 1.00
-[[Nothing]]
+|game7= arma3
+|version7= 0.50
-'''Description:'''
+|eff= local
-Text background - arguments in format '''''["name", "type", speed]''''' or '''''["name", "type"]'''''.<br>
+|gr1= GUI Control
-If speed is not given, 1 is assumed.<br>
-Type may be one of:
-* '''"PLAIN"'''
+|descr= Displays a text message in the center of the screen. The text can be displayed on multiple lines by using "\n" new line characters: <sqf inline>cutText ["line1\nline2\nline3", "PLAIN"];</sqf>
-* '''"PLAIN DOWN"'''
-* '''"BLACK"'''
-* '''"BLACK FADED"'''
-* '''"BLACK OUT"'''
-* '''"BLACK IN"'''
-* '''"WHITE OUT"'''
-* '''"WHITE IN"'''
-Also see [[titleText]], with these two commands you can show two different texts at once (optimally with two different types).
+{{Feature|arma3|For greater efficiency and ease of modability it is recommended to use named layers through the alternative syntax.}}
+|s1= [[cutText]] [text, type, speed, showInMap, isStructuredText, drawOverHUD]
-'''Example:'''
+|p1= text: [[String]] - text to be displayed
-'''cutText''' ["", "BLACK OUT"]
+|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.
-'''cutText''' ["", "BLACK OUT", 10]
+|p3= speed: [[Number]] - (Optional, default 1) time in seconds to fade in resource. If 0 or less, default value is used
+|p4= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened
+|p4since= arma3 0.50
+|p5= isStructuredText: [[Boolean]] - (Optional, default [[false]]) [[true]] to switch support for [[Structured Text]] formatting - see {{Link|#Example 4}}
+|p5since= arma3 1.74
+|p6= drawOverHUD: [[Boolean]] - (Optional, default [[true]]) [[false]] to show the text under in-game HUD
+|p6since= arma3 2.16
+|r1= [[Nothing]]
+|s2= layer [[cutText]] [text, type, speed, showInMap, isStructuredText, drawOverHUD]
+|s2since= arma3 1.58
+|p21= 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.
+|p22= text: [[String]] - text to be displayed
+|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.
+|p24= speed: [[Number]] - (Optional, default -1) time in seconds to fade in resource. If 0 or less, default value is used
+|p25= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened
+|p26= isStructuredText: [[Boolean]] - (Optional, default [[false]]) [[true]] to switch support for [[Structured Text]] formatting - see {{Link|#Example 4}}
+|p26since= arma3 1.74
+|p27= drawOverHUD: [[Boolean]] - (Optional, default [[true]]) [[false]] to show the text under in-game HUD
+|p27since= arma3 2.16
+|r2=
+* [[Nothing]] when ''layer'' is a [[Number]]
+* [[Number]] when ''layer is a [[String]]
+|x1= <sqf>
+cutText ["", "BLACK OUT"];
+cutText ["Hello World!", "PLAIN", 2];
+</sqf>
+|x2= <sqf>2 cutText ["Hello World!", "PLAIN", 2]; // returns nothing</sqf>
+|x3= <sqf>
+private _layer1 = "normal" cutText ["In The Centre", "PLAIN"];
+private _layer2 = "down" cutText ["At The Bottom", "PLAIN DOWN"];
+</sqf>
+|x4= <sqf>cutText ["<t color='#ff0000' size='5'>RED ALERT!</t><br/>***********", "PLAIN", -1, true, true];</sqf>
+|seealso= [[allCutLayers]] [[titleText]] [[cutRsc]] [[cutObj]] [[cutFadeOut]] [[allActiveTitleEffects]] [[activeTitleEffectParams]]
+}}