BIS fnc typeText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Fix parameters and examples)
m (Text replacement - "BIS fnc " to "BIS_fnc_")
 
(27 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|eff= local
____________________________________________________________________________________________


| Types a structured text on the screen, letter by letter, cursor blinking.[[File:BIS fnc typeText.gif|left|400px]]|Description=
|gr1= GUI
____________________________________________________________________________________________


| [stringLines, posX, posY, rootFormat] call [[BIS_fnc_typeText]] |Syntax=
|descr= 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:
|p1= stringLines:
* [[Array]] of [[String|Strings]] - array containing lines of text with same structured text formatting.
* [[Array]] of [[String]]s - array containing lines of text with same structured text formatting.
* [[Array]] of [[Array]] of [[String|Strings]] [text, format, blinkCount]
* [[Array]] of [[Array]]s format [text, format, blinkCount]:
** text: [[String]] - (Optional, default "")
** text: [[String]] - (Optional, default "")
** 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
|Parameter 1=


|p2= posX: [[Number]] - (Optional, default 0) |Parameter 2=
|p2= posX: [[Number]] - (Optional, default 0)


|p3= posY: [[Number]] - (Optional, default 0) |Parameter 3=
|p3= posY: [[Number]] - (Optional, default 0)


|p4= rootFormat: [[String]] - (Optional, default "<t>%1</t>") the parent format |Parameter 4=
|p4= rootFormat: [[String]] - (Optional, default "<t>%1</t>") the parent format


| [[Nothing]] |Return value=
|r1= [[Nothing]]
____________________________________________________________________________________________


|x1= <code>[
|x1= <sqf>
[
[
[
["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>"],
["RESUPPLY POINT", "<t align = 'center' shadow = '1' size = '0.7'>%1</t>&lt;br/&gt;"],
["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]
["10 MINUTES LATER ...", "<t align = 'center' shadow = '1' size = '1.0'>%1</t>", 15]
]
]
] [[spawn]] [[BIS_fnc_typeText]];</code> |Example 1=
] spawn BIS_fnc_typeText;
</sqf>


|x2= <code>[
|x2= <sqf>[
[
[
["Hello there...", [[nil]], 30]
["Hello there...", nil, 30]
],
],
0, [[safeZoneY]] + [[safeZoneH]] / 2
0, safeZoneY + safeZoneH / 2
] [[spawn]] [[BIS_fnc_typeText]];</code> |Example 2=
] spawn BIS_fnc_typeText;</sqf>
____________________________________________________________________________________________


|exec= spawn |Execution=
|exec= spawn


| [[BIS_fnc_dynamicText]], [[BIS_fnc_infoText]], [[BIS_fnc_textTiles]], [[BIS_fnc_typeText2]] |See also=
|seealso= [[BIS_fnc_dynamicText]] [[BIS_fnc_infoText]] [[BIS_fnc_textTiles]] [[BIS_fnc_typeText2]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: GUI|{{uc:typeText}}]]
[[Category:Functions|{{uc:typeText}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:typeText}}]]

Latest revision as of 12:15, 27 July 2022

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

Description

Description:
Types a structured text on the screen, letter by letter, cursor blinking.
BIS fnc typeText.gif
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 Arrays format [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:
Nothing

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_dynamicText BIS_fnc_infoText BIS_fnc_textTiles BIS_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=329328"