cutText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *(arg|eff|mp|serverExec|gr[0-9]) *= *(.*) * *\|([^=]{12})" to "|$1=$2 |descr=$3")
m (Some wiki formatting)
 
(26 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofp
|game1= ofp
|1.00
|version1= 1.00


|game2= ofpe
|game2= ofpe
Line 26: Line 26:
|gr1= GUI Control
|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:<br><tt>[[cutText]] ["line1\nline2\nline3", "PLAIN"];</tt>. Since Arma 3 v1.74 this command supports [[Structured Text]] formatting.
|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 available with alternative syntax since Arma 3 v1.58}}
{{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]
|s1= [[cutText]] [text, type, speed, showInMap, isStructuredText, drawOverHUD]


|p1= text: [[String]] - text to be displayed
|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.
|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.
|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. {{Since|arma3}}
|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 Example 4. {{Since|arma3|1.73.142260|y}}
|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]]
|r1= [[Nothing]]


|s2= layer [[cutText]] [text, type, speed, showInMap, isStructuredText]
|s2= layer [[cutText]] [text, type, speed, showInMap, isStructuredText, drawOverHUD]
 
|s2since= arma3 1.58


|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.
|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
|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.
|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.
 
|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 Example 4. {{Since|arma3|1.73.142260|y}}
 
|r2= [[Nothing]]
 
|s3= layerName [[cutText]]  [text, type, speed,  showInMap, isStructuredText] {{Since|arma3|1.57.134673|y}}
 
|p41= layerName: [[String]] - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE
 
|p42= text: [[String]] - text to be displayed


|p43= 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


|p44= speed: [[Number]] - (Optional, default -1) Time in seconds to fade in resource.
|p25= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened


|p46= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened. {{Since|arma3||y}}
|p26= isStructuredText: [[Boolean]] - (Optional, default [[false]]) [[true]] to switch support for [[Structured Text]] formatting - see {{Link|#Example 4}}
|p26since= arma3 1.74


|p47= isStructuredText: [[Boolean]] - (Optional, default [[false]]) [[true]] to switch support for [[Structured Text]] formatting - see Example 4. {{Since|arma3|1.73.142260|y}}
|p27= drawOverHUD: [[Boolean]] - (Optional, default [[true]]) [[false]] to show the text under in-game HUD
|p27since= arma3 2.16


|r3= [[Number]] - number of the allocated layer
|r2=
* [[Nothing]] when ''layer'' is a [[Number]]
* [[Number]] when ''layer is a [[String]]


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


|x2= <code>2 [[cutText]] ["Hello World!", "PLAIN", 2];</code>
|x2= <sqf>2 cutText ["Hello World!", "PLAIN", 2]; // returns nothing</sqf>


|x3= <code>_layer1 = "normal" [[cutText]] ["In The Centre", "PLAIN"];
|x3= <sqf>
_layer2 = "down" [[cutText]] ["At The Bottom", "PLAIN DOWN"];</code>
private _layer1 = "normal" cutText ["In The Centre", "PLAIN"];
private _layer2 = "down" cutText ["At The Bottom", "PLAIN DOWN"];
</sqf>


|x4=Since Arma 3 v1.74:<code>[[cutText]] ["&lt;t color='#ff0000' size='5'>RED ALERT!&lt;/t>&lt;br/>***********", "PLAIN", -1, [[true]], [[true]]];</code>
|x4= <sqf>cutText ["<t color='#ff0000' size='5'>RED ALERT!</t><br/>***********", "PLAIN", -1, true, true];</sqf>


|seealso= [[allCutLayers]], [[titleText]], [[cutRsc]], [[cutObj]], [[cutFadeOut]], [[allActiveTitleEffects]]
|seealso= [[allCutLayers]] [[titleText]] [[cutRsc]] [[cutObj]] [[cutFadeOut]] [[allActiveTitleEffects]] [[activeTitleEffectParams]]  
}}
}}
<dl class="command_description">
<dt></dt>
<dd class="notedate">Posted on September 20, 2013 - 06:59</dd>
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]</dt>
<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.
</dl>
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
<dl class="command_description">
<dt></dt>
<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>

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"