titleText: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " " to " ") |
Lou Montana (talk | contribs) m (Text replacement - " \| (\[\[[a-zA-Z ]+\]\]) \|x1=" to " |r1=$1 |x1=") |
||
Line 22: | Line 22: | ||
|p6= isStructuredText (Optional): [[Boolean]] - [[true]] to switch support for [[Structured Text]] formatting. Default: [[false]] (See Example 3. Available since Arma 3 v1.74) | |p6= isStructuredText (Optional): [[Boolean]] - [[true]] to switch support for [[Structured Text]] formatting. Default: [[false]] (See Example 3. Available since Arma 3 v1.74) | ||
| [[Nothing]] | |r1=[[Nothing]] | ||
|x1= <code>[[titleText]] ["Show this text", "PLAIN"];</code> | |x1= <code>[[titleText]] ["Show this text", "PLAIN"];</code> |
Revision as of 21:22, 10 June 2021
Description
- Description:
- Description needed
- Groups:
- GUI Control
Syntax
- Syntax:
- Syntax needed
- 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.74)
- Return Value:
- Nothing
Examples
- Example 1:
titleText ["Show this text", "PLAIN"];
- Example 2:
titleText ["Your message", "BLACK", 2];
- Example 3:
- Since Arma 3 v1.74:
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
- 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)