titleText: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:Scripting Commands OFP 1.[4-9]{2}(\|(\{\{uc:\{\{PAGENAME\}\}\}\}|#|[A-Z]+))?\]\] " to "") |
m (Text replacement - "v1\.73\.[0-9]{6}" to "v1.74") |
||
| Line 10: | Line 10: | ||
| 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: | | 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: | ||
<tt>[[titleText]] ["line1\nline2\nline3", "PLAIN"];</tt>. Since Arma 3 v1. | <tt>[[titleText]] ["line1\nline2\nline3", "PLAIN"];</tt>. Since Arma 3 v1.74 this command supports [[Structured Text]] formatting. | ||
| '''titleText''' [text, type, speed, showInMap, isStructuredText] | | '''titleText''' [text, type, speed, showInMap, isStructuredText] | ||
| Line 20: | Line 20: | ||
|p4= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 | |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]] | |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. | |p6= isStructuredText (Optional): [[Boolean]] - [[true]] to switch support for [[Structured Text]] formatting. Default: [[false]] (See Example 3. Available since Arma 3 v1.74) | ||
| [[Nothing]] | | [[Nothing]] | ||
| Line 27: | Line 27: | ||
|x2= <code>[[titleText]] ["Your message", "BLACK", 2];</code> | |x2= <code>[[titleText]] ["Your message", "BLACK", 2];</code> | ||
|x3=Since Arma 3 v1. | |x3=Since Arma 3 v1.74:<code>[[titleText]] ["<t color='#ff0000' size='5'>RED ALERT!</t><br/>***********", "PLAIN", -1, [[true]], [[true]]];</code> | ||
|seealso= [[titleFadeOut]], [[cutText]], [[cutObj]], [[allActiveTitleEffects]] | |seealso= [[titleFadeOut]], [[cutText]], [[cutObj]], [[allActiveTitleEffects]] | ||
Revision as of 10:21, 3 April 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:
- Return value needed
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)