cutText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(structured text support)
m (template:command argument fix)
Line 10: Line 10:


| 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>
| 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>
{{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
{{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=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''cutText''' [text, type, speed,  showInMap, isStructuredText] |= Syntax
| '''cutText''' [text, type, speed,  showInMap, isStructuredText] |SYNTAX=
|p1= [text, type, speed,  showInMap, isStructuredText]: [[Array]] |= Parameter 1
|p1= [text, type, speed,  showInMap, isStructuredText]: [[Array]] |PARAMETER1=
|p2= text: [[String]] - text to be displayed |= Parameter 2
|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. |= Parameter 3
|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 |= Parameter 4
|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}}'') |= Parameter 5
|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) |= Parameter 3
|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]] |= Return value
| [[Nothing]] |RETURNVALUE=


|s2= layer '''cutText''' [text, type, speed,  showInMap, isStructuredText] |= Syntax
|s2= layer '''cutText''' [text, type, speed,  showInMap, isStructuredText] |SYNTAX=
|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. |= Parameter 2
|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=
|p22= [text, type, speed,  showInMap, isStructuredText]: [[Array]] |=Parameter 1
|p22= [text, type, speed,  showInMap, isStructuredText]: [[Array]] |PARAMETER1=
|p23= text: [[String]] - text to be displayed |= Parameter 3
|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. |= Parameter 4
|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 |= Parameter 5
|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}}'') |= Parameter 6
|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) |= Parameter 3
|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]] |= Return value
|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
|s3= layerName '''cutText''' [text, type, speed,  showInMap, isStructuredText]  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since Arma 3 v1.57.134673'') |SYNTAX=
|p41= layerName: [[String]] - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE |= Parameter 2
|p41= layerName: [[String]] - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE |PARAMETER2=
|p42= [text, type, speed,  showInMap, isStructuredText]: [[Array]] |=Parameter 1
|p42= [text, type, speed,  showInMap, isStructuredText]: [[Array]] |PARAMETER1=
|p43= text: [[String]] - text to be displayed |= Parameter 3
|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. |= Parameter 4
|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 |= Parameter 5
|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}}'') |= Parameter 6
|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) |= Parameter 3
|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 |= Return value
|r3= [[Number]] - number of the allocated layer |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>[[cutText]] ["","BLACK OUT"];
|x1= <code>[[cutText]] ["","BLACK OUT"];
[[cutText]] ["Hello World!","PLAIN",2];</code> |= Example 1
[[cutText]] ["Hello World!","PLAIN",2];</code> |EXAMPLE1=


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


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


| [[allCutLayers]], [[titleText]], [[cutRsc]], [[cutObj]], [[cutFadeOut]] |= See also
| [[allCutLayers]], [[titleText]], [[cutRsc]], [[cutObj]], [[cutFadeOut]] |SEEALSO=


}}
}}

Revision as of 14:37, 7 April 2019

Logo A0.png1.00
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"];. Since Arma 3 v1.73.142260 this command supports Structured Text formatting.

Arma 3
For greater efficiency and ease of modability it is recommended to use named layers available with alternative syntax since Arma 3 v1.57.134673
Groups:
Uncategorised

Syntax 1

Syntax:
cutText [text, type, speed, showInMap, isStructuredText]
Parameters:
[text, type, speed, showInMap, isStructuredText]: Array
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 (Optional): Number - Time in seconds to fade in resource. Default: -1
showInMap (Optional): Boolean - false to hide the text when the map is opened. Default: true    (Introduced in Arma 3)
isStructuredText (Optional): Boolean - true to switch support for Structured Text formatting. Default: false (See Example 4. Available since Arma 3 v1.73.142260)
Return Value:
Nothing

Syntax 2

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, type, speed, showInMap, isStructuredText]: Array
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 (Optional): Number - Time in seconds to fade in resource. Default: -1
showInMap (Optional): Boolean - false to hide the text when the map is opened. Default: true    (Introduced in Arma 3)
isStructuredText (Optional): Boolean - true to switch support for Structured Text formatting. Default: false (See Example 4. Available since Arma 3 v1.73.142260)
Return Value:
Nothing

Syntax 3

Syntax:
layerName cutText [text, type, speed, showInMap, isStructuredText]        (Since Arma 3 v1.57.134673)
Parameters:
layerName: String - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE
[text, type, speed, showInMap, isStructuredText]: Array
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 (Optional): Number - Time in seconds to fade in resource. Default: -1
showInMap (Optional): Boolean - false to hide the text when the map is opened. Default: true    (Introduced in Arma 3)
isStructuredText (Optional): Boolean - true to switch support for Structured Text formatting. Default: false (See Example 4. Available since Arma 3 v1.73.142260)
Return Value:
Number - number of the allocated layer

Examples

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

Additional Information

See also:
allCutLayerstitleTextcutRsccutObjcutFadeOut

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

Notes

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.

Bottom Section

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