cutText: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (see also) |
Badguy360th (talk | contribs) No edit summary |
||
Line 13: | Line 13: | ||
| '''cutText''' [text,type,speed,showOnMap] |= Syntax | | '''cutText''' [text,type,speed,showOnMap] |= Syntax | ||
|p1= text: [[String]] - text to be displayed |= Parameter | |p1= [text,type,speed,showOnMap]: [[Array]] |= Parameter 1 | ||
| | |p2= text: [[String]] - text to be displayed |= Parameter 2 | ||
| | |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 | ||
| | |p4= speed: [[Number]] - Time in seconds to fade in resource (optional, default: 1) |= Parameter 4 | ||
|p5= showOnMap: [[Boolean]] - [[false]] to hide the text when the map is opened (''Introduced in {{arma3}}''). |= Parameter 5 | |||
| [[Nothing]] |= Return value | | [[Nothing]] |= Return value | ||
|s2= layer '''cutText''' [text,type,speed,showOnMap] (''Introduced in Arma 2 / VBS2 (1.30+).'')|= Syntax | |s2= layer '''cutText''' [text,type,speed,showOnMap] (''Introduced in Arma 2 / VBS2 (1.30+).'')|= Syntax | ||
|p21= layer: [[Number]] - Defines the layer in which the effect is shown, where 0 is the backmost one. |= Parameter | |p21= [text,type,speed,showOnMap]: [[Array]] =Parameter 1 | ||
| | |p22= layer: [[Number]] - Defines the layer in which the effect is shown, where 0 is the backmost one. |= Parameter 2 | ||
| | |p23= text: [[String]] - text to be displayed |= Parameter 3 | ||
| | |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 | ||
| | |p25= speed: [[Number]] - Time in seconds to fade in resource (optional, default: 1) |= Parameter 5 | ||
|p26= showOnMap: [[Boolean]] - [[false]] to hide the text when the map is opened (''Introduced in {{arma3}}''). |= Parameter 6 | |||
|r2= [[Nothing]] |= Return value | |r2= [[Nothing]] |= Return value | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ |
Revision as of 16:59, 30 August 2015
Description
- Description:
- Displays a text message in the center of the screen.
- Groups:
- Uncategorised
Syntax
- Syntax:
- cutText [text,type,speed,showOnMap]
- Parameters:
- [text,type,speed,showOnMap]: 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: Number - Time in seconds to fade in resource (optional, default: 1)
- showOnMap: Boolean - false to hide the text when the map is opened (Introduced in Arma 3).
- Return Value:
- Nothing
Alternative Syntax
- Syntax:
- layer cutText [text,type,speed,showOnMap] (Introduced in Arma 2 / VBS2 (1.30+).)
- Parameters:
- [text,type,speed,showOnMap]: Array =Parameter 1
- layer: Number - Defines the layer in which the effect is shown, where 0 is the backmost one.
- 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 - Time in seconds to fade in resource (optional, default: 1)
- showOnMap: Boolean - false to hide the text when the map is opened (Introduced in Arma 3).
- Return Value:
- Nothing
Examples
- Example 1:
cutText ["","BLACK OUT"]; cutText ["Hello World!","PLAIN",2];
- Example 2:
2 cutText ["Hello World!","PLAIN",2];
- Example 3:
1000 cutText ["In The Centre","PLAIN"]; 1001 cutText ["At The Bottom","PLAIN DOWN"];
Additional Information
- See also:
- titleTextcutRsccutObjcutFadeOut
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
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.00
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Command Group: Uncategorised
- Scripting Commands: Local Effect
- Scripting Commands OFP 1.99
- Scripting Commands OFP 1.96
- Scripting Commands OFP 1.46
- Scripting Commands ArmA
- Command Group: Interaction
- Scripting Commands ArmA2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters