cutText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (corr. classification)
(separated syntax variations)
Line 9: Line 9:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Text background - '''effect''' is in format ["text", "type", (speed)].
| Displays a text message in the center of the screen.|= Description
 
If speed is not given, 1 is assumed.
 
Type may be one of:
* "PLAIN"
* "PLAIN DOWN"
* "BLACK"
* "BLACK FADED"
* "BLACK OUT"
* "BLACK IN"
* "WHITE OUT"
* "WHITE IN"
 
See [[Title Effect Type]] for more information about these values. |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| (layer) '''cutText''' effect |= Syntax
| '''cutText''' [text,type,speed] |= Syntax
 
|p1= text: [[String]] - text to be displayed |= Parameter 1
|p1= layer: [[Number]] - This parameter is optional and only available in Arma 2. Omit it for earlier versions. It defines the layer in which the effect is shown, where 0 is the back most. |= Parameter 1
|p2= type: [[String]] one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See [[GUI Interaction]] for more information about these values. |= Parameter 2
 
|p3= speed: [[Number]] - Time in seconds to fade in resource (optional, default: 1) |= Parameter 3
|p2= effect: [[Array]] |= Parameter 2
| [[Nothing]] |= Return value


|p3= text: [[String]] - the text to be displayed |= Parameter 3
|s2= layer '''cutText''' [text,type,speed] (''Only available in Arma 2 or VBS2 (1.30+).'')|= Syntax
 
|p21= layer: [[Number]] - Defines the layer in which the effect is shown, where 0 is the backmost one. |= Parameter 1
|p4= type: [[String]] |= Parameter 4
|p22= text: [[String]] - text to be displayed |= Parameter 2
 
|p23= type: [[String]] one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See [[GUI Interaction]] for more information about these values. |= Parameter 3
|p5= speed: [[Number]] - time in seconds in which the text will be faded in. |= Parameter 5
|p24= speed: [[Number]] - Time in seconds to fade in resource (optional, default: 1) |= Parameter 4
 
|r2= [[Nothing]] |= Return value
| [[Nothing]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   

Revision as of 22:03, 25 September 2009

Hover & click on the images for description

Description

Description:
Displays a text message in the center of the screen.
Groups:
Uncategorised

Syntax

Syntax:
cutText [text,type,speed]
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 GUI Interaction for more information about these values.
speed: Number - Time in seconds to fade in resource (optional, default: 1)
Return Value:
Nothing

Alternative Syntax

Syntax:
layer cutText [text,type,speed] (Only available in Arma 2 or VBS2 (1.30+).)
Parameters:
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 GUI Interaction for more information about these values.
speed: Number - Time in seconds to fade in resource (optional, default: 1)
Return Value:
Nothing

Examples

Example 1:
cutText ["","BLACK OUT"]
cutText ["Hello World!","PLAIN",2]
Example 2:
2 cutText ["Hello World!","PLAIN",2];

Additional Information

See also:
titleTextcutRsccutObj

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

Bottom Section