cutText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|SYNTAX= |p21=" to "|SYNTAX2= |p21=")
m (Some wiki formatting)
 
(73 intermediate revisions by 5 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


|eff= local |Multiplayer Effects=
|game3= arma1
____________________________________________________________________________________________
|version3= 1.00


| Displays a text message in the center of the screen. The text can be displayed on multiple lines by using "\n" new line characters:<br><tt>[[cutText]] ["line1\nline2\nline3", "PLAIN"];</tt>. Since Arma 3 v1.73.142260 this command supports [[Structured Text]] formatting.<br><br>
|game4= arma2
{{Feature arma3|For greater efficiency and ease of modability it is recommended to use named layers available with alternative syntax since Arma 3 v1.57.134673}}|DESCRIPTION=
|version4= 1.00
____________________________________________________________________________________________


| '''cutText''' [text, type, speed,  showInMap, isStructuredText] |SYNTAX=
|game5= arma2oa
|p1= [text, type, speed,  showInMap, isStructuredText]: [[Array]] |PARAMETER1=
|version5= 1.50
|p2= text: [[String]] - text to be displayed |PARAMETER2=
|p3= 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. |PARAMETER3=
|p4= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |PARAMETER4=
|p5= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]] &nbsp;&nbsp;&nbsp;(''Introduced in {{arma3}}'') |PARAMETER5=
|p6= isStructuredText (Optional): [[Boolean]] - [[true]] to switch support for [[Structured Text]] formatting. Default: [[false]] (See Example 4. Available since Arma 3 v1.73.142260) |PARAMETER3=
| [[Nothing]] |RETURNVALUE=


|s2= layer '''cutText''' [text, type, speed,  showInMap, isStructuredText] |SYNTAX2=
|game6= tkoh
|version6= 1.00


|p21= 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. |PARAMETER2=
|game7= arma3
|p22= [text, type, speed,  showInMap, isStructuredText]: [[Array]] |PARAMETER1=
|version7= 0.50
|p23= text: [[String]] - text to be displayed |PARAMETER3=
|p24= 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. |PARAMETER4=
|p25= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |PARAMETER5=
|p26= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]] &nbsp;&nbsp;&nbsp;(''Introduced in {{arma3}}'') |PARAMETER6=
|p27= isStructuredText (Optional): [[Boolean]] - [[true]] to switch support for [[Structured Text]] formatting. Default: [[false]] (See Example 4. Available since Arma 3 v1.73.142260) |PARAMETER3=
|r2= [[Nothing]] |RETURNVALUE=


|s3= layerName '''cutText''' [text, type, speed,  showInMap, isStructuredText]  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since Arma 3 v1.57.134673'') |SYNTAX=
|eff= local
|p41= layerName: [[String]] - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE |PARAMETER2=
|p42= [text, type, speed,  showInMap, isStructuredText]: [[Array]] |PARAMETER1=
|p43= text: [[String]] - text to be displayed |PARAMETER3=
|p44= 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. |PARAMETER4=
|p45= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |PARAMETER5=
|p46= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]] &nbsp;&nbsp;&nbsp;(''Introduced in {{arma3}}'') |PARAMETER6=
|p47= isStructuredText (Optional): [[Boolean]] - [[true]] to switch support for [[Structured Text]] formatting. Default: [[false]] (See Example 4. Available since Arma 3 v1.73.142260) |PARAMETER3=
|r3= [[Number]] - number of the allocated layer |RETURNVALUE=
____________________________________________________________________________________________
 
|x1= <code>[[cutText]] ["","BLACK OUT"];
[[cutText]] ["Hello World!","PLAIN",2];</code> |EXAMPLE1=


|x2= <code>2 [[cutText]] ["Hello World!","PLAIN",2];</code> |EXAMPLE2=
|gr1= GUI Control


|x3= <code>_layer1 = "normal" [[cutText]] ["In The Centre","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>
_layer2 = "down" [[cutText]] ["At The Bottom","PLAIN DOWN"];</code> |EXAMPLE3=


|x4=Since Arma 3 v1.73.142260:<code>[[cutText]] ["&lt;t color='#ff0000' size='5'>RED ALERT!&lt;/t>&lt;br/>***********", "PLAIN", -1, [[true]], [[true]]];</code> |EXAMPLE4=
{{Feature|arma3|For greater efficiency and ease of modability it is recommended to use named layers through the alternative syntax.}}
____________________________________________________________________________________________


| [[allCutLayers]], [[titleText]], [[cutRsc]], [[cutObj]], [[cutFadeOut]] |SEEALSO=
|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


<h3 style="display:none">Notes</h3>
|r2=
<dl class="command_description">
* [[Nothing]] when ''layer'' is a [[Number]]
<!-- Note Section BEGIN -->
* [[Number]] when ''layer is a [[String]]
<dd class="notedate">Posted on September 20, 2013 - 06:59
<dt class="note">'''[[User:Killzone_Kid|Killzone_Kid]]'''<dd class="note">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.


|x1= <sqf>
cutText ["", "BLACK OUT"];
cutText ["Hello World!", "PLAIN", 2];
</sqf>


<!-- Note Section END -->
|x2= <sqf>2 cutText ["Hello World!", "PLAIN", 2]; // returns nothing</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|x3= <sqf>
private _layer1 = "normal" cutText ["In The Centre", "PLAIN"];
private _layer2 = "down" cutText ["At The Bottom", "PLAIN DOWN"];
</sqf>


[[Category:Scripting Commands|CUTTEXT]]
|x4= <sqf>cutText ["<t color='#ff0000' size='5'>RED ALERT!</t><br/>***********", "PLAIN", -1, true, true];</sqf>
[[Category:Scripting Commands OFP 1.99|CUTTEXT]]
[[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}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
|seealso= [[allCutLayers]] [[titleText]] [[cutRsc]] [[cutObj]] [[cutFadeOut]] [[allActiveTitleEffects]] [[activeTitleEffectParams]]  
<dl class="command_description">
}}
<dd class="notedate">Posted on July 6, 2016 - 13:32 (UTC)</dd>
<dt class="note">[[User:Krzmbrzl00|Krzmbrzl00]]</dt>
<dd class="note">
The value for '''speed''' has to be greater 0. If 0 is used as speed the default value (1) will be used.<br>
If you want to create an "instant" effect you can use a really small value (e.g. 0.001)
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 17: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"