cutText: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "<code>([^ ]*)\[\[([a-zA-Z0-9_]+)\]\]([^ ]*)<\/code>" to "<code>$1$2$3</code>") |
Lou Montana (talk | contribs) m (Text replacement - "<code>([^ ]*)\[\[([a-zA-Z0-9_]+)\]\]([^ ]*)<\/code>" to "<code>$1$2$3</code>") |
||
Line 91: | Line 91: | ||
_layer2 = "down" [[cutText]] ["At The Bottom", "PLAIN DOWN"];</code> | _layer2 = "down" [[cutText]] ["At The Bottom", "PLAIN DOWN"];</code> | ||
|x4= <code>cutText ["<t color='#ff0000' size='5'>RED ALERT!</t><br/>***********", "PLAIN", -1, | |x4= <code>cutText ["<t color='#ff0000' size='5'>RED ALERT!</t><br/>***********", "PLAIN", -1, true, [[true]]];</code> | ||
|seealso= [[allCutLayers]] [[titleText]] [[cutRsc]] [[cutObj]] [[cutFadeOut]] [[allActiveTitleEffects]] [[activeTitleEffectParams]] | |seealso= [[allCutLayers]] [[titleText]] [[cutRsc]] [[cutObj]] [[cutFadeOut]] [[allActiveTitleEffects]] [[activeTitleEffectParams]] |
Revision as of 11:02, 12 May 2022
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.
- since 0.50
- showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened
- since 1.74
- isStructuredText: Boolean - (Optional, default false) true to switch support for Structured Text formatting - see Example 4
- 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.
- since 0.50
- showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened
- since 1.74
- isStructuredText: Boolean - (Optional, default false) true to switch support for Structured Text formatting - see Example 4
- Return Value:
- Nothing
Syntax 3
- Syntax:
- layerName cutText [text, type, speed, showInMap, isStructuredText]
- 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
- since 1.74
- isStructuredText: Boolean - (Optional, default false) true to switch support for Structured Text formatting - see Example 4
- 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:
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
- 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