cutText: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (see also) |
Lou Montana (talk | contribs) m (Text replacement - " \{\{GameCategory\|[a-z]+[0-9]?\|Scripting Commands\}\}" to "") |
||
(43 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| ofp | | |game1= ofp | ||
|version1= 1.00 | |||
|1.00 | |game2= ofpe | ||
|version2= 1.00 | |||
| | |game3= arma1 | ||
|version3= 1.00 | |||
| | |game4= arma2 | ||
|version4= 1.00 | |||
| | |game5= arma2oa | ||
|version5= 1.50 | |||
| | |||
| | |game6= tkoh | ||
|version6= 1.00 | |||
| | |game7= arma3 | ||
| | |version7= 0.50 | ||
| | |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:<br><tt>[[cutText]] ["line1\nline2\nline3", "PLAIN"];</tt>. Since Arma 3 v1.74 this command supports [[Structured Text]] formatting. | ||
| | {{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}} | ||
| | |s1= '''cutText''' [text, type, speed, showInMap, isStructuredText] | ||
| | |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. | ||
|p4= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened. {{Since|arma3}} | |||
|p5= isStructuredText: [[Boolean]] - (Optional, default [[false]]) [[true]] to switch support for [[Structured Text]] formatting - see Example 4. {{Since|arma3|1.73.142260|y}} | |||
|r1= [[Nothing]] | |||
|s2= layer [[cutText]] [text, type, speed, showInMap, isStructuredText] | |||
|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. | |||
|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. | |||
|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. | |||
|p44= speed: [[Number]] - (Optional, default -1) Time in seconds to fade in resource. | |||
|p46= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened. {{Since|arma3||y}} | |||
|p47= isStructuredText: [[Boolean]] - (Optional, default [[false]]) [[true]] to switch support for [[Structured Text]] formatting - see Example 4. {{Since|arma3|1.73.142260|y}} | |||
|r3= [[Number]] - number of the allocated layer | |||
|x1= <code>[[cutText]] ["", "BLACK OUT"]; | |||
[[cutText]] ["Hello World!", "PLAIN", 2];</code> | |||
|x2= <code>2 [[cutText]] ["Hello World!", "PLAIN", 2];</code> | |||
|x3= <code>_layer1 = "normal" [[cutText]] ["In The Centre", "PLAIN"]; | |||
_layer2 = "down" [[cutText]] ["At The Bottom", "PLAIN DOWN"];</code> | |||
|x4=Since Arma 3 v1.74:<code>[[cutText]] ["<t color='#ff0000' size='5'>RED ALERT!</t><br/>***********", "PLAIN", -1, [[true]], [[true]]];</code> | |||
|seealso= [[allCutLayers]], [[titleText]], [[cutRsc]], [[cutObj]], [[cutFadeOut]], [[allActiveTitleEffects]] | |||
}} | }} | ||
<dl class="command_description"> | <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> | </dl> | ||
<dl class="command_description"> | |||
< | <dt></dt> | ||
< | |||
<dd class="notedate">Posted on July 6, 2016 - 13:32 (UTC)</dd> | <dd class="notedate">Posted on July 6, 2016 - 13:32 (UTC)</dd> | ||
<dt class="note">[[User:Krzmbrzl00|Krzmbrzl00]]</dt> | <dt class="note">[[User:Krzmbrzl00|Krzmbrzl00]]</dt> | ||
Line 92: | Line 108: | ||
If you want to create an "instant" effect you can use a really small value (e.g. 0.001) | If you want to create an "instant" effect you can use a really small value (e.g. 0.001) | ||
</dd> | </dd> | ||
</dl> | </dl> | ||
Revision as of 23:31, 16 June 2021
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.74 this command supports Structured Text formatting. - Groups:
- GUI Control
Syntax 1
- Syntax:
- cutText [text, type, speed, showInMap, isStructuredText]
- 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.
- showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened. Template:Since
- isStructuredText: Boolean - (Optional, default false) true to switch support for Structured Text formatting - see Example 4. Template:Since
- 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: 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.
- showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened.
- isStructuredText: Boolean - (Optional, default false) true to switch support for Structured Text formatting - see Example 4. Template:Since
- Return Value:
- Nothing
Syntax 3
- Syntax:
- layerName cutText [text, type, speed, showInMap, isStructuredText] Template:Since
- Parameters:
- layerName: 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.
- showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened. Template:Since
- isStructuredText: Boolean - (Optional, default false) true to switch support for Structured Text formatting - see Example 4. Template:Since
- 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.74:
cutText ["<t color='#ff0000' size='5'>RED ALERT!</t><br/>***********", "PLAIN", -1, true, true];
Additional Information
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
- 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.
- 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)
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.00
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Operation Flashpoint: Elite: Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: GUI Control
- Scripting Commands: Local Effect