BIS fnc typeText2: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (see also)
(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=


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


____________________________________________________________________________________________
____________________________________________________________________________________________


| Types a structured text on the screen, letter by letter, cursor blinking.[[File:BIS fnc typeText2.gif|left|400px]]|= Description
| Types a structured text on the screen, letter by letter, cursor blinking. Note that line returns are manual, unlike [[BIS_fnc_typeText]].
[[File:BIS fnc typeText2.gif|left|400px]]
|Description=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [stringLines, posX, posY, alignBottom, rootFormat, abortParams, abortCond, playSounds] call [[BIS_fnc_typeText2]] |= Syntax
| [stringLines, posX, posY, alignBottom, rootFormat, abortParams, abortCond, playSounds] call [[BIS_fnc_typeText2]] |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, 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")
|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= alignBottom: [[Boolean]] - (Optional, default [[true]]) |Parameter 4=


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


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


|p6= abortParams: [[Array]] - (Optional, default []) |= Parameter 6
|p7= abortCond: [[Code]] - (Optional, default {{Inline code|{ [[false]] }}}) |Parameter 7=


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


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


|x1= <code>[
|x1= <code>[
[
[
  ["CAMP ROGAIN,","align = 'center' shadow = '1' size = '0.7' font='PuristaBold'"],
["CAMP ROGAIN, ", "align = 'center' shadow = '1' size = '0.7' font='PuristaBold'"],
  ["RESSUPLY POINT","align = 'center' shadow = '1' size = '0.7'","#aaaaaa"],
["RESUPPLY POINT", "align = 'center' shadow = '1' size = '0.7'", "#aaaaaa"],
  ["","&lt;br/&gt;"],
["","&lt;br/&gt;"], {{codecomment|// line break}}
  ["10 MINUTES LATER ...","align = 'center' shadow = '1' size = '1.0'"]
["10 MINUTES LATER...","align = 'center' shadow = '1' size = '1.0'"]
]
]
] [[spawn]] [[BIS_fnc_typeText2]];</code> |= Example 1
] [[spawn]] [[BIS_fnc_typeText2]];</code> |Example 1=


|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
|x2= <code>[
["Hello there"],
[[safeZoneX]], [[safeZoneH]] / 2,
[[true]],
"<t font='PuristaBold'>%1</t>",
[],
{ [[false]] },
[[true]]
] [[spawn]] [[BIS_fnc_typeText2]];</code> |Example 2=
____________________________________________________________________________________________
____________________________________________________________________________________________


|exec= spawn |= Execution
|exec= spawn |Execution=


| [[BIS_fnc_dynamicText]], [[BIS_fnc_infoText]], [[BIS_fnc_textTiles]], [[BIS_fnc_typeText]], [[BIS_fnc_EXP_camp_SITREP]]  |= See also
| [[BIS_fnc_dynamicText]], [[BIS_fnc_infoText]], [[BIS_fnc_textTiles]], [[BIS_fnc_typeText]], [[BIS_fnc_EXP_camp_SITREP]]  |See also=


}}
}}

Revision as of 17:52, 8 January 2019

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. Note that line returns are manual, unlike BIS_fnc_typeText.
BIS fnc typeText2.gif
Execution:
spawn
Groups:
Uncategorised

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_dynamicTextBIS_fnc_infoTextBIS_fnc_textTilesBIS_fnc_typeTextBIS_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

Notes

Bottom Section

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