cutText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(updated)
(Arma2 layer parameter)
Line 9: Line 9:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Text background - '''effect''' is in format ["name", "type", speed] or ["name", "type"].
| Text background - '''effect''' is in format ["text", "type", (speed)].


If speed is not given, 1 is assumed.
If speed is not given, 1 is assumed.
Line 26: Line 26:
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''cutText''' effect |= Syntax
| (layer) '''cutText''' effect |= Syntax


|p1= effect: [[Array]] |= 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= name: [[String]] - the text to be displayed |= Parameter 2
|p2= effect: [[Array]] |= Parameter 2


|p3= type: [[String]] |= Parameter 3
|p3= text: [[String]] - the text to be displayed |= Parameter 3


|p4= speed: [[Number]] - time in seconds in which the text will be faded in. |= Parameter 4
|p4= type: [[String]] |= Parameter 4
 
|p5= speed: [[Number]] - time in seconds in which the text will be faded in. |= Parameter 5


| [[Nothing]] |= Return value
| [[Nothing]] |= Return value
Line 41: Line 43:
|x1= <pre>cutText ["","BLACK OUT"]
|x1= <pre>cutText ["","BLACK OUT"]
cutText ["Hello World!","PLAIN",2]</pre> |= Example 1
cutText ["Hello World!","PLAIN",2]</pre> |= Example 1
|x2= <pre>2 cutText ["Hello World!","PLAIN",2];</pre> |= Example 2
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[titleText]] |= See also
| [[titleText]], [[cutRsc]], [[cutObj]] |= See also


}}
}}

Revision as of 06:08, 22 June 2009

Logo A0.png1.00
Hover & click on the images for description

Description

Description:
Text background - effect is in format ["text", "type", (speed)]. 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.
Groups:
Uncategorised

Syntax

Syntax:
(layer) cutText effect
Parameters:
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.
effect: Array
text: String - the text to be displayed
type: String
speed: Number - time in seconds in which the text will be faded in.
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

Retrieved from "https://community.bistudio.com/wiki?title=cutText&oldid=50107"