BIS fnc typeText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (fixed example 2)
(Fix parameters and examples)
Line 1: Line 1:
{{Function|= Comments
{{Function|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| arma3 |Game name=


|1.00|= Game version
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| [stringLines, posX, posY, rootFormat] call [[BIS_fnc_typeText]] |= Syntax
| [stringLines, posX, posY, rootFormat] call [[BIS_fnc_typeText]] |Syntax=


|p1= stringLines: [[Array]] of [[String|Strings]] - array containing blocks of text with same structured text formatting.
|p1= stringLines:
* Every text block is an array of text and formatting tag.
* [[Array]] of [[String|Strings]] - array containing lines of text with same structured text formatting.
* Blocks don't have to span over whole line. |= Parameter 1
* [[Array]] of [[Array]] of [[String|Strings]] [text, format, blinkCount]
** text: [[String]] - (Optional, default "")
** 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
|Parameter 1=


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


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


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


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


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


|x2= <code><nowiki>[</nowiki>["Hello there"], [[safeZoneX]] + [[safeZoneW]] / 2, [[safeZoneY]] + [[safeZoneH]] / 2, "<t font='PuristaBold'>%1</t>"] [[spawn]] [[BIS_fnc_typeText]];</code> |= Example 2
|x2= <code>[
[
["Hello there...", [[nil]], 30]
],
0, [[safeZoneY]] + [[safeZoneH]] / 2
] [[spawn]] [[BIS_fnc_typeText]];</code> |Example 2=
____________________________________________________________________________________________
____________________________________________________________________________________________


|exec= spawn |= Execution
|exec= spawn |Execution=
 
| [[BIS_fnc_dynamicText]], [[BIS_fnc_infoText]], [[BIS_fnc_textTiles]], [[BIS_fnc_typeText2]] |= See also


| [[BIS_fnc_dynamicText]], [[BIS_fnc_infoText]], [[BIS_fnc_textTiles]], [[BIS_fnc_typeText2]] |See also=
}}
}}


Revision as of 19:54, 8 January 2019

Arma 3 logo black.png1.00
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:
Uncategorised

Syntax

Syntax:
[stringLines, posX, posY, rootFormat] call 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:
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_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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_typeText&oldid=116077"