BIS fnc typeText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[[cC]ategory:[fF]unctions\|\{\{uc:[a-z A-Z_]*\}\}\]\]" to "")
m (formatted code behind, named params and endl for image)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function
| arma3|1.00|gr1= GUI| Types a structured text on the screen, letter by letter, cursor blinking.[[File:BIS fnc typeText.gif|left|400px]]| [stringLines, posX, posY, rootFormat] spawn [[BIS_fnc_typeText]]|p1= stringLines:
 
|game1 = arma3
 
|version1 = 1.00
 
|arg = local
 
|eff = local
 
|descr= arma3|1.00|gr1= GUI| Types a structured text on the screen, letter by letter, cursor blinking.<br>
[[File:BIS fnc typeText.gif|left|400px]]|  
 
|s1= [stringLines, posX, posY, rootFormat] spawn [[BIS_fnc_typeText]]
 
|p1= stringLines:
* [[Array]] of [[String|Strings]] - array containing lines of text with same structured text formatting.
* [[Array]] of [[String|Strings]] - array containing lines of text with same structured text formatting.
* [[Array]] of [[Array]] of [[String|Strings]] [text, format, blinkCount]
* [[Array]] of [[Array]] of [[String|Strings]] [text, format, blinkCount]
Line 6: Line 20:
** format: [[String]] - (Optional, default "<t align = 'center' shadow = '1' size = '0.7'>%1</t>&lt;br/&gt;")
** format: [[String]] - (Optional, default "<t align = 'center' shadow = '1' size = '0.7'>%1</t>&lt;br/&gt;")
** blinkCount: [[Number]] - (Optional, default 5) number of cursor blinks after text typing
** blinkCount: [[Number]] - (Optional, default 5) number of cursor blinks after text typing
|p2= posX: [[Number]] - (Optional, default 0)|p3= posY: [[Number]] - (Optional, default 0)|p4= rootFormat: [[String]] - (Optional, default "<t>%1</t>") the parent format| [[Nothing]]|x1= <code>[
 
|p2= posX: [[Number]] - (Optional, default 0)|p3= posY: [[Number]] - (Optional, default 0)|p4= rootFormat: [[String]] - (Optional, default "<t>%1</t>") the parent format| [[Nothing]]
 
|x1= <code>[
[
[
["CAMP ROGAIN,", "<t align = 'center' shadow = '1' size = '0.7' font='PuristaBold'>%1</t>"],
["CAMP ROGAIN,", "<t align = 'center' shadow = '1' size = '0.7' font='PuristaBold'>%1</t>"],
Line 12: Line 29:
["10 MINUTES LATER ...", "<t align = 'center' shadow = '1' size = '1.0'>%1</t>", 15]
["10 MINUTES LATER ...", "<t align = 'center' shadow = '1' size = '1.0'>%1</t>", 15]
]
]
] [[spawn]] [[BIS_fnc_typeText]];</code>|x2= <code>[
] [[spawn]] [[BIS_fnc_typeText]];</code>
 
|x2= <code>[
[
[
["Hello there...", [[nil]], 30]
["Hello there...", [[nil]], 30]
],
],
0, [[safeZoneY]] + [[safeZoneH]] / 2
0, [[safeZoneY]] + [[safeZoneH]] / 2
] [[spawn]] [[BIS_fnc_typeText]];</code>|exec= spawn| [[BIS_fnc_dynamicText]], [[BIS_fnc_infoText]], [[BIS_fnc_textTiles]], [[BIS_fnc_typeText2]]
] [[spawn]] [[BIS_fnc_typeText]];</code>
}}


|exec= spawn


|seealso= [[BIS_fnc_dynamicText]], [[BIS_fnc_infoText]], [[BIS_fnc_textTiles]], [[BIS_fnc_typeText2]]
}}


[[Category:{{Name|arma3}}: Functions|{{uc:typeText}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:typeText}}]]

Revision as of 02:05, 5 February 2021

Arma 3 logo black.png1.00
LALocalLELocal
Hover & click on the images for description

Description

Description:
arma3
Execution:
spawn
Groups:
GUI

Syntax

Syntax:
[stringLines, posX, posY, rootFormat] spawn BIS_fnc_typeText
Parameters:
stringLines:
  • Array of Strings - array containing lines of text with same structured text formatting.
  • Array of Array of Strings [text, format, blinkCount]
    • text: String - (Optional, default "")
    • format: String - (Optional, default "<t align = 'center' shadow = '1' size = '0.7'>%1</t><br/>")
    • blinkCount: Number - (Optional, default 5) number of cursor blinks after text typing
posX: Number - (Optional, default 0)
posY: Number - (Optional, default 0)
rootFormat: String - (Optional, default "<t>%1</t>") the parent format
Return Value:
Return value needed

Examples

Example 1:
[ [ ["CAMP ROGAIN,", "<t align = 'center' shadow = '1' size = '0.7' font='PuristaBold'>%1</t>"], ["RESUPPLY POINT", "<t align = 'center' shadow = '1' size = '0.7'>%1</t><br/>"], ["10 MINUTES LATER ...", "<t align = 'center' shadow = '1' size = '1.0'>%1</t>", 15] ] ] spawn BIS_fnc_typeText;
Example 2:
[ [ ["Hello there...", nil, 30] ], 0, safeZoneY + safeZoneH / 2 ] spawn BIS_fnc_typeText;

Additional Information

See also:
BIS_fnc_dynamicTextBIS_fnc_infoTextBIS_fnc_textTilesBIS_fnc_typeText2

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_typeText&oldid=238999"