cutText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
[[Category:Scripting Commands|CUTTEXT]]
{{Command|= Comments
[[Category:Scripting Commands OFP 1.96|CUTTEXT]]
____________________________________________________________________________________________
[[Category:Scripting Commands OFP 1.46|CUTTEXT]]
 
[[Category:Scripting Commands ArmA|CUTTEXT]]
| ofp |= Game name


|1.00|= Game version


<h2 style="color:#000066"> '''cutText ''effect'''''</h2>
|eff= local |= Effects in MP
____________________________________________________________________________________________


| Display a text background. |= Description
____________________________________________________________________________________________


'''Operand types:'''
| '''cutText''' [text, type, speed*] * optional |= Syntax


'''effect:''' [[Array]]
|p1= text: [[String]] - the text to be displayed |= Parameter 1


'''Type of returned value:'''
|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


[[Nothing]]
|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


'''Description:'''
| [[Nothing]] |= Return value
____________________________________________________________________________________________
 
|x1= <pre>cutText ["","BLACK OUT"]
cutText ["Hello World!","PLAIN",2]</pre> |= Example 1
____________________________________________________________________________________________


Text background - arguments in format '''''["name", "type", speed]''''' or '''''["name", "type"]'''''.<br>
| [[titleText]] |= See also
If speed is not given, 1 is assumed.<br>
Type may be one of:


* '''"PLAIN"'''
}}
* '''"PLAIN DOWN"'''
* '''"BLACK"'''
* '''"BLACK FADED"'''
* '''"BLACK OUT"'''
* '''"BLACK IN"'''
* '''"WHITE OUT"'''
* '''"WHITE IN"'''


Also see [[titleText]], with these two commands you can show two different texts at once (optimally with two different types).
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
</dl>


'''Example:'''
<h3 style="display:none">Bottom Section</h3>


'''cutText''' ["", "BLACK OUT"]
[[Category:Scripting Commands|CUTTEXT]]
'''cutText''' ["", "BLACK OUT", 10]
[[Category:Scripting Commands OFP 1.96|CUTTEXT]]
[[Category:Scripting Commands OFP 1.46|CUTTEXT]]
[[Category:Scripting Commands ArmA|CUTTEXT]]

Revision as of 23:40, 1 August 2006

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

Description

Description:
Display a text background.
Groups:
Uncategorised

Syntax

Syntax:
cutText [text, type, speed*] * optional
Parameters:
text: String - the 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 in which the text will be faded in. If no speed is given, an assumed value is set.
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

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