cutText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(separated syntax variations)
m (Some wiki formatting)
 
(99 intermediate revisions by 13 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
|game1= ofp
|version1= 1.00


|1.00|= Game version
|game2= ofpe
|version2= 1.00


|effect= local |= Effects in MP
|game3= arma1
____________________________________________________________________________________________
|version3= 1.00


| Displays a text message in the center of the screen.|= Description
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| '''cutText''' [text,type,speed] |= Syntax
|game5= arma2oa
|p1= text: [[String]] - text to be displayed |= Parameter 1
|version5= 1.50
|p2= type: [[String]] one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See [[GUI Interaction]] for more information about these values. |= Parameter 2
|p3= speed: [[Number]] - Time in seconds to fade in resource (optional, default: 1) |= Parameter 3
| [[Nothing]] |= Return value


|s2= layer '''cutText''' [text,type,speed] (''Only available in Arma 2 or VBS2 (1.30+).'')|= Syntax
|game6= tkoh
|p21= layer: [[Number]] - Defines the layer in which the effect is shown, where 0 is the backmost one. |= Parameter 1
|version6= 1.00
|p22= text: [[String]] - text to be displayed |= Parameter 2
|p23= type: [[String]] one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See [[GUI Interaction]] for more information about these values. |= Parameter 3
|p24= speed: [[Number]] - Time in seconds to fade in resource (optional, default: 1) |= Parameter 4
|r2= [[Nothing]] |= Return value
____________________________________________________________________________________________
 
|x1= <pre>cutText ["","BLACK OUT"]
cutText ["Hello World!","PLAIN",2]</pre> |= Example 1


|x2= <pre>2 cutText ["Hello World!","PLAIN",2];</pre> |= Example 2
|game7= arma3
____________________________________________________________________________________________
|version7= 0.50


| [[titleText]], [[cutRsc]], [[cutObj]] |= See also
|eff= local


}}
|gr1= GUI Control
 
|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>
 
{{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]
 
|p1= text: [[String]] - text to be displayed
 
|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.
 
|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>


<h3 style="display:none">Notes</h3>
|x2= <sqf>2 cutText ["Hello World!", "PLAIN", 2]; // returns nothing</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x3= <sqf>
</dl>
private _layer1 = "normal" cutText ["In The Centre", "PLAIN"];
private _layer2 = "down" cutText ["At The Bottom", "PLAIN DOWN"];
</sqf>


<h3 style="display:none">Bottom Section</h3>
|x4= <sqf>cutText ["<t color='#ff0000' size='5'>RED ALERT!</t><br/>***********", "PLAIN", -1, true, true];</sqf>


[[Category:Scripting Commands|CUTTEXT]]
|seealso= [[allCutLayers]] [[titleText]] [[cutRsc]] [[cutObj]] [[cutFadeOut]] [[allActiveTitleEffects]] [[activeTitleEffectParams]]
[[Category:Scripting Commands OFP 1.96|CUTTEXT]]
}}
[[Category:Scripting Commands OFP 1.46|CUTTEXT]]
[[Category:Scripting Commands ArmA|CUTTEXT]]
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]

Latest revision as of 16:58, 7 November 2023

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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"];
Arma 3
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 Arma 3 logo black.png0.50
showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened
since Arma 3 logo black.png1.74
isStructuredText: Boolean - (Optional, default false) true to switch support for Structured Text formatting - see Example 4
since Arma 3 logo black.png2.16
drawOverHUD: Boolean - (Optional, default true) false to show the text under in-game HUD
Return Value:
Nothing

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 Arma 3 logo black.png1.74
isStructuredText: Boolean - (Optional, default false) true to switch support for Structured Text formatting - see Example 4
since Arma 3 logo black.png2.16
drawOverHUD: Boolean - (Optional, default true) false to show the text under in-game HUD
Return Value:

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
Retrieved from "https://community.bistudio.com/wiki?title=cutText&oldid=347960"