titleText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "{{HashLink" to "{{Link")
 
(73 intermediate revisions by 13 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
|game1= ofp
|version1= 1.00


|1.00|= Game version
|game2= ofpe
____________________________________________________________________________________________
|version2= 1.00


| Text title - <br> Also see [[cutText]], with these two commands you can show two different texts at once (optimally with two different types).
|game3= arma1
|version3= 1.00


<i>type</i> may be one of:
|game4= arma2
|version4= 1.00


• "PLAIN"
|game5= arma2oa
|version5= 1.50


• "PLAIN DOWN"
|game6= tkoh
|version6= 1.00


• "BLACK"
|game7= arma3
|version7= 0.50


• "BLACK FADED"
|eff= local


• "BLACK OUT"
|gr1= GUI Control


"BLACK IN"
|descr= Displays text across the screen. If used along with [[cutText]] two different texts (in different type styles) can be shown at once.
The text can be displayed on multiple lines by using "\n" new line characters (see {{Link|#Example 3}}).


• "WHITE OUT"
|s1= [[titleText]] [text, type, speed,  showInMap, isStructuredText]


• "WHITE IN"
|p1= text: [[String]] - text to be displayed


See [[Title Effect Type]] for more information about these types. |= Description
|p2= 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.
____________________________________________________________________________________________


| '''titleText''' [text, type, speed] |= Syntax
|p3= speed: [[Number]] - (Optional, default -1) time in seconds to fade in resource


|p1= [text, type, speed]: [[Array]] |= Parameter 1
|p4= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened
|p2= text: [[String]] |= Parameter 2
|p3= type: [[String]]. |= Parameter 3
|p4= speed: [[Number]] Optional. Default 1 |= Parameter 4


| [[Nothing]] |= Return value
|p5= isStructuredText: [[Boolean]] - (Optional, default [[false]]) [[true]] to switch support for [[Structured Text]] formatting - see {{Link|#Example 4}}
____________________________________________________________________________________________
|p5since= arma3 1.74
 
|x1= <pre>titleText ["Show this text", "PLAIN"]</pre> |= Example 1
____________________________________________________________________________________________


|mp=This function only works locally|
|r1= [[Nothing]]
| [[titleFadeOut]] |= See also


}}
|x1= <sqf>titleText ["Show this text", "PLAIN"];</sqf>


<h3 style="display:none">Notes</h3>
|x2= <sqf>titleText ["Your message", "BLACK", 2];</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


See also [[titleFadeOut]] --[[User:Crowe|Crowe]] 16:20, 7 November 2007 (CET)
|x3= <sqf>titleText ["line1\nline2\nline3", "PLAIN"];</sqf>


<!-- Note Section END -->
|x4= <sqf>titleText ["<t color='#ff0000' size='5'>RED ALERT!</t><br/>***********", "PLAIN", -1, true, true];</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[titleFadeOut]] [[cutText]] [[cutObj]] [[allActiveTitleEffects]] [[activeTitleEffectParams]]
}}


[[Category:Scripting Commands|TITLETEXT]]
{{Note
[[Category:Scripting Commands OFP 1.96|TITLETEXT]]
|user= DreadedEntity
[[Category:Scripting Commands OFP 1.46|TITLETEXT]]
|timestamp= 20141121090300
[[Category:Scripting Commands ArmA|TITLETEXT]]
|text= The third parameter or 'speed', as it is called in the description, refers to the amount of time the message will be shown on-screen. Multiply each number by 10 to get the number of seconds it will be shown. You can even use floats as input, like 0.1, to show a message for only 1 second.<br><br>
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
'''Note''': Calculating the time with that method does not include the time it takes to fade in/out, which is about 1 second unless you use numbers lower than 1.<br>
'''Note''': Using anything lower than 0.001 seems to have no effect, or the effect is so little it is negligible.<br>
'''(A3 1.34.128075)'''
}}

Latest revision as of 17:43, 4 January 2023

Hover & click on the images for description

Description

Description:
Displays text across the screen. If used along with cutText two different texts (in different type styles) can be shown at once. The text can be displayed on multiple lines by using "\n" new line characters (see Example 3).
Groups:
GUI Control

Syntax

Syntax:
titleText [text, type, speed, showInMap, isStructuredText]
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 Title Effect Types for more information about these values.
speed: Number - (Optional, default -1) time in seconds to fade in resource
showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened
since Arma 3 logo black.png1.74
isStructuredText: Boolean - (Optional, default false) true to switch support for Structured Text formatting - see Example 4
Return Value:
Nothing

Examples

Example 1:
titleText ["Show this text", "PLAIN"];
Example 2:
titleText ["Your message", "BLACK", 2];
Example 3:
titleText ["line1\nline2\nline3", "PLAIN"];
Example 4:
titleText ["<t color='#ff0000' size='5'>RED ALERT!</t><br/>***********", "PLAIN", -1, true, true];

Additional Information

See also:
titleFadeOut cutText cutObj allActiveTitleEffects activeTitleEffectParams

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
DreadedEntity - c
Posted on Nov 21, 2014 - 09:03 (UTC)
The third parameter or 'speed', as it is called in the description, refers to the amount of time the message will be shown on-screen. Multiply each number by 10 to get the number of seconds it will be shown. You can even use floats as input, like 0.1, to show a message for only 1 second.

Note: Calculating the time with that method does not include the time it takes to fade in/out, which is about 1 second unless you use numbers lower than 1.
Note: Using anything lower than 0.001 seems to have no effect, or the effect is so little it is negligible.
(A3 1.34.128075)