titleText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
m (Text replacement - "{{HashLink" to "{{Link")
 
(36 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command
{{RV|type=command


| ofp
|game1= ofp
|version1= 1.00


|1.00
|game2= ofpe
|version2= 1.00
 
|game3= arma1
|version3= 1.00
 
|game4= arma2
|version4= 1.00
 
|game5= arma2oa
|version5= 1.50
 
|game6= tkoh
|version6= 1.00
 
|game7= arma3
|version7= 0.50


|eff= local
|eff= local
Line 9: Line 26:
|gr1= GUI Control
|gr1= GUI Control


| 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:
|descr= Displays text across the screen. If used along with [[cutText]] two different texts (in different type styles) can be shown at once.
<tt>[[titleText]] ["line1\nline2\nline3", "PLAIN"];</tt>. Since Arma 3 v1.73.142260 this command supports [[Structured Text]] formatting.
The text can be displayed on multiple lines by using "\n" new line characters (see {{Link|#Example 3}}).


| '''titleText''' [text, type, speed,  showInMap, isStructuredText]
|s1= [[titleText]] [text, type, speed,  showInMap, isStructuredText]


|p1 = [text, type, speed, showInMap, isStructuredText]: [[Array]]
|p1= text: [[String]] - text to be displayed
|p2= text: [[String]] - text to be displayed


|p3= 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.
|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.
|p4= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1
|p5= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]
|p6= isStructuredText (Optional): [[Boolean]] - [[true]] to switch support for [[Structured Text]] formatting. Default: [[false]] (See Example 3. Available since Arma 3 v1.73.142260)


| [[Nothing]]
|p3= speed: [[Number]] - (Optional, default -1) time in seconds to fade in resource
 
|x1= <code>[[titleText]] ["Show this text", "PLAIN"];</code>
|x2= <code>[[titleText]] ["Your message", "BLACK", 2];</code>


|x3=Since Arma 3 v1.73.142260:<code>[[titleText]] ["&lt;t color='#ff0000' size='5'>RED ALERT!&lt;/t>&lt;br/>***********", "PLAIN", -1, [[true]], [[true]]];</code>
|p4= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened


| [[titleFadeOut]], [[cutText]], [[cutObj]], [[allActiveTitleEffects]]
|p5= isStructuredText: [[Boolean]] - (Optional, default [[false]]) [[true]] to switch support for [[Structured Text]] formatting - see {{Link|#Example 4}}
|p5since= arma3 1.74


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


|x2= <sqf>titleText ["Your message", "BLACK", 2];</sqf>


[[Category:Scripting Commands|TITLETEXT]]
|x3= <sqf>titleText ["line1\nline2\nline3", "PLAIN"];</sqf>
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|TITLETEXT]]
[[Category:Scripting Commands OFP 1.46|TITLETEXT]]
{{GameCategory|arma1|Scripting Commands}}


{{GameCategory|arma2|Scripting Commands}}
|x4= <sqf>titleText ["<t color='#ff0000' size='5'>RED ALERT!</t><br/>***********", "PLAIN", -1, true, true];</sqf>
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}


<!-- CONTINUE Notes -->
|seealso= [[titleFadeOut]] [[cutText]] [[cutObj]] [[allActiveTitleEffects]] [[activeTitleEffectParams]]  
<dl class="command_description">
}}
<dd class="notedate">Posted on November 21, 2014 - 09:03 (UTC)</dd>
<dt class="note">[[User:DreadedEntity|DreadedEntity]]</dt>
<dd class="note">
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>


{{Note
|user= DreadedEntity
|timestamp= 20141121090300
|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>
'''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''': 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>
'''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)'''
'''(A3 1.34.128075)'''
</dd>
}}
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 18:43, 4 January 2023

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LELocal
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)
Retrieved from "https://community.bistudio.com/wiki?title=titleText&oldid=336846"