BIS fnc typeText2: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Params filling)
m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)")
 
(28 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
|gr1= GUI


|eff= local |= Effects in MP
|eff= local


____________________________________________________________________________________________
|descr= [[File:BIS_fnc_typeText2.gif|400px|right]]
Types a structured text on the screen, letter by letter, cursor blinking. Note that line returns are manual, unlike [[BIS_fnc_typeText]].


| Types a structured text on the screen, letter by letter, cursor blinking. |= Description
|s1= [stringLines, posX, posY, alignBottom, rootFormat, abortParams, abortCond, playSounds] call [[BIS_fnc_typeText2]]
____________________________________________________________________________________________


| [stringLines, posX, posY, alignBottom, rootFormat, abortParams, abortCond, playSounds] call [[BIS_fnc_typeText2]] |= Syntax
|p1= stringLines:
* [[Array]] of [[String]]s - array containing lines of text with same structured text formatting.
* [[Array]] of [[Array]] of [[String]]s [text, format, color]
** text: [[String]] - (Optional, default <sqf inline>""</sqf>)
** format: [[String]] - (Optional, default <sqf inline>"align = 'center' size = '0.7'"</sqf>) a linebreak is defined as "&lt;br/&gt;" '''and this only!'''
** color: [[String]] - (Optional, default <sqf inline>"#ffffff"</sqf>)


|p1= stringLines: [[Array]] of [[String|Strings]] - array containing blocks of text with same structured text formatting.
|p2= posX: [[Number]] - (Optional, default 0)
* Every text block is an array of text and formatting tag.
* Blocks don't have to span over whole line. |= Parameter 1


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


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


|p4= alignBottom: [[Boolean]] - (Optional, default [[true]]) |= Parameter 4
|p5= rootFormat: [[String]] - (Optional, default <sqf inline>"<t>%1</t>"</sqf>)


|p5= rootFormat: [[String]] - (Optional, default "<t >%1</t>") |= Parameter 5
|p6= abortParams: [[Array]] - (Optional, default <sqf inline>[]</sqf>)


|p6= abortParams: [[Array]] - (Optional, default []) |= Parameter 6
|p7= abortCond: [[Code]] - (Optional, default <sqf inline>{ false }</sqf>)


|p7= abortCond: [[Code]] - (Optional, default { [[false]] }) |= Parameter 7
|p8= playSounds: [[Boolean]] - (Optional, default [[true]])


|p8= playSounds: [[Boolean]] - (Optional, default [[true]]) |= Parameter 8
|r1= [[Nothing]]


| [[Nothing]] |= Return value
|x1= <sqf>
____________________________________________________________________________________________
[
[
["CAMP ROGAIN, ", "align = 'center' shadow = '1' size = '0.7' font='PuristaBold'"],
["RESUPPLY POINT", "align = 'center' shadow = '1' size = '0.7'", "#aaaaaa"],
["", "<br/>"], // line break
["10 MINUTES LATER...", "align = 'center' shadow = '1' size = '1.0'"]
]
] spawn BIS_fnc_typeText2;
</sqf>


|x1= <code>[
|x2= <sqf>
[
[
  ["CAMP ROGAIN,","align = 'center' shadow = '1' size = '0.7' font='PuristaBold'"],
["Hello there"],
  ["RESSUPLY POINT","align = 'center' shadow = '1' size = '0.7'","#aaaaaa"],
safeZoneX, safeZoneH / 2,
  ["","&lt;br/&gt;"],
true,
  ["10 MINUTES LATER ...","align = 'center' shadow = '1' size = '1.0'"]
"<t font='PuristaBold'>%1</t>",
]
[],
] [[spawn]] [[BIS_fnc_typeText2]];</code> |= Example 1
{ false },
true
] spawn BIS_fnc_typeText2;
</sqf>


|x2= <code><nowiki>[</nowiki>["Hello there"], [[safeZoneW]] / 2, [[safeZoneH]] / 2, [[true]], "<t font='PuristaBold'>%1</t>", [], { [[false]] }, [[true]]] [[spawn]] [[BIS_fnc_typeText2]];</code> |= Example 2
|exec= spawn
____________________________________________________________________________________________
 
|exec= spawn |= Execution
 
| [[BIS_fnc_dynamicText]], [[BIS_fnc_infoText]], [[BIS_fnc_textTiles]], [[BIS_fnc_typeText]] |= See also


|seealso= [[BIS_fnc_dynamicText]] [[BIS_fnc_infoText]] [[BIS_fnc_textTiles]] [[BIS_fnc_typeText]] [[BIS_fnc_EXP_camp_SITREP]]
}}
}}
<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:typeText2}}]]
[[Category:Functions|{{uc:typeText2}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:typeText2}}]]

Latest revision as of 19:09, 8 November 2023

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

Description

Description:
BIS fnc typeText2.gif
Types a structured text on the screen, letter by letter, cursor blinking. Note that line returns are manual, unlike BIS_fnc_typeText.
Execution:
spawn
Groups:
GUI

Syntax

Syntax:
[stringLines, posX, posY, alignBottom, rootFormat, abortParams, abortCond, playSounds] call BIS_fnc_typeText2
Parameters:
stringLines:
  • Array of Strings - array containing lines of text with same structured text formatting.
  • Array of Array of Strings [text, format, color]
    • text: String - (Optional, default "")
    • format: String - (Optional, default "align = 'center' size = '0.7'") a linebreak is defined as "<br/>" and this only!
    • color: String - (Optional, default "#ffffff")
posX: Number - (Optional, default 0)
posY: Number - (Optional, default 0)
alignBottom: Boolean - (Optional, default true)
rootFormat: String - (Optional, default "<t>%1</t>")
abortParams: Array - (Optional, default [])
abortCond: Code - (Optional, default { false })
playSounds: Boolean - (Optional, default true)
Return Value:
Nothing

Examples

Example 1:
[ [ ["CAMP ROGAIN, ", "align = 'center' shadow = '1' size = '0.7' font='PuristaBold'"], ["RESUPPLY POINT", "align = 'center' shadow = '1' size = '0.7'", "#aaaaaa"], ["", "<br/>"], // line break ["10 MINUTES LATER...", "align = 'center' shadow = '1' size = '1.0'"] ] ] spawn BIS_fnc_typeText2;
Example 2:
[ ["Hello there"], safeZoneX, safeZoneH / 2, true, "<t font='PuristaBold'>%1</t>", [], { false }, true ] spawn BIS_fnc_typeText2;

Additional Information

See also:
BIS_fnc_dynamicText BIS_fnc_infoText BIS_fnc_textTiles BIS_fnc_typeText BIS_fnc_EXP_camp_SITREP

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_typeText2&oldid=349484"