titleText: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "[[Category:Scripting Commands ArmA|" to "[[Category:Scripting Commands Armed Assault|") |
m (Text replacement - " it's" to " it is") |
||
Line 60: | Line 60: | ||
<dt class="note">[[User:DreadedEntity|DreadedEntity]]</dt> | <dt class="note">[[User:DreadedEntity|DreadedEntity]]</dt> | ||
<dd class="note"> | <dd class="note"> | ||
The third parameter or 'speed', as it | 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 | '''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> | </dd> | ||
</dl> | </dl> | ||
<!-- DISCONTINUE Notes --> | <!-- DISCONTINUE Notes --> |
Revision as of 08:56, 8 September 2020
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: titleText ["line1\nline2\nline3", "PLAIN"];. Since Arma 3 v1.73.142260 this command supports Structured Text formatting.
- Groups:
- Uncategorised
Syntax
- Syntax:
- titleText [text, type, speed, showInMap, isStructuredText]
- Parameters:
- [text, type, speed, showInMap, isStructuredText]: Array
- 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 (Optional): Number - Time in seconds to fade in resource. Default: -1
- showInMap (Optional): Boolean - false to hide the text when the map is opened. Default: true
- isStructuredText (Optional): Boolean - true to switch support for Structured Text formatting. Default: false (See Example 3. Available since Arma 3 v1.73.142260)
- Return Value:
- Nothing
Examples
- Example 1:
titleText ["Show this text", "PLAIN"];
- Example 2:
titleText ["Your message", "BLACK", 2];
- Example 3:
- Since Arma 3 v1.73.142260:
titleText ["<t color='#ff0000' size='5'>RED ALERT!</t><br/>***********", "PLAIN", -1, true, true];
Additional Information
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
- Posted on November 21, 2014 - 09:03 (UTC)
- DreadedEntity
-
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)
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.00
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Command Group: Uncategorised
- Scripting Commands: Local Effect
- Scripting Commands OFP 1.99
- Scripting Commands OFP 1.96
- Scripting Commands OFP 1.46
- Scripting Commands Armed Assault
- Command Group: Interaction
- Scripting Commands Arma 2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters