cutText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (change link to skip a redirect page)
mNo edit summary
Line 6: Line 6:
|1.00|= Game version
|1.00|= Game version


|eff= local |= Effects in MP
|effect= local |= Effects in MP
____________________________________________________________________________________________
____________________________________________________________________________________________


| Display a text background. |= Description
| Text background - '''effect''' is in format ["name", "type", speed] or ["name", "type"].
 
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
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''cutText''' [text, type, speed*] * optional |= Syntax
| '''cutText''' effect |= Syntax


|p1= text: [[String]] - the text to be displayed |= Parameter 1
|p1= name: [[String]] - the text to be displayed |= Parameter 1


|p2= type: [[String]] - one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See [[Title Effect Type]] for more information about these values. |= Parameter 2
|p2= type: [[String]] |= Parameter 2


|p3= speed: [[Number]] - time in seconds in which the text will be faded in. If no speed is given, an assumed value is set. |= Parameter 3
|p3= speed: [[Number]] - time in seconds in which the text will be faded in. |= Parameter 3


| [[Nothing]] |= Return value
| [[Nothing]] |= Return value

Revision as of 05:33, 17 February 2007

Hover & click on the images for description

Description

Description:
Text background - effect is in format ["name", "type", speed] or ["name", "type"]. 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:
cutText effect
Parameters:
name: 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]

Additional Information

See also:
titleText

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