Difference between revisions of "titleText"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
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.73.142260 this command supports [[Structured Text]] formatting.|= Description
+
<tt>[[titleText]] ["line1\nline2\nline3", "PLAIN"];</tt>. Since Arma 3 v1.73.142260 this command supports [[Structured Text]] formatting.|DESCRIPTION=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| '''titleText''' [text, type, speed,  showInMap, isStructuredText] |= Syntax
+
| '''titleText''' [text, type, speed,  showInMap, isStructuredText] |SYNTAX=
  
 
|p1 = [text, type, speed, showInMap, isStructuredText]: [[Array]]
 
|p1 = [text, type, speed, showInMap, isStructuredText]: [[Array]]
|p2= text: [[String]] - text to be displayed |= Parameter 1
+
|p2= text: [[String]] - text to be displayed |PARAMETER1=
|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.|= Parameter 2
+
|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.|PARAMETER2=
|p4= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |= Parameter 3
+
|p4= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |PARAMETER3=
|p5= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |= Parameter 3
+
|p5= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |PARAMETER3=
|p6= isStructuredText (Optional): [[Boolean]] - [[true]] to switch support for [[Structured Text]] formatting. Default: [[false]] (See Example 3. Available since Arma 3 v1.73.142260) |= Parameter 3
+
|p6= isStructuredText (Optional): [[Boolean]] - [[true]] to switch support for [[Structured Text]] formatting. Default: [[false]] (See Example 3. Available since Arma 3 v1.73.142260) |PARAMETER3=
  
| [[Nothing]] |= Return value
+
| [[Nothing]] |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
   
 
   
|x1= <code>[[titleText]] ["Show this text", "PLAIN"];</code> |= Example 1
+
|x1= <code>[[titleText]] ["Show this text", "PLAIN"];</code> |EXAMPLE1=
|x2= <code>[[titleText]] ["Your message", "BLACK", 2];</code> |= Example 2
+
|x2= <code>[[titleText]] ["Your message", "BLACK", 2];</code> |EXAMPLE2=
  
|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> |= Example 3
+
|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> |EXAMPLE3=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[titleFadeOut]], [[cutText]] |= See also
+
| [[titleFadeOut]], [[cutText]] |SEEALSO=
  
 
}}
 
}}

Revision as of 15:50, 7 April 2019

Introduced with Operation Flashpoint version 1.00
  Effects of this scripting command are not broadcasted over the network and remain local to the client the command is executed on

Click on the images for descriptions

Introduced in

Game:
Operation Flashpoint
Version:
1.00

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.

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

Multiplayer:
-
See also:
titleFadeOutcutText

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section

Posted on November 21, 2014 - 09:03 (UTC)
DreadedEntity
The third parameter or 'speed', as it's 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's negligible.
(A3 1.34.128075)