BIS fnc textTiles: Difference between revisions

Revision as of 16:34, 18 August 2021

1.00

LELocal

Hover & click on the images for description

Description

Description:: Shows an animated text with background tiles.
Execution:: spawn
Groups:: GUI

Syntax

Syntax:

[content, position, tileSize, duration, fadeInOutTime, tileTransparency] spawn BIS_fnc_textTiles

Parameters:

content: String or Structured Text

String - path to texure
Structured Text - formatted text

position: Boolean or Array (optional, default [0, 0, 1, 1])

Boolean - true to use mission area set in the layout options, false for full screen
Array - screen space coordinates in format [x, y, w, h]

tileSize: Number or Array (optional, default 10 ([10,10])

Number - tile size in screen space coordinates. Tile will be square
Array - tile size in screen space coordinates in format [w, h]

duration: Number - (optional, default 5) duration in seconds

fadeInOutTime: Number or Array - (optional, default 0) duration of the fade effect in seconds

Array - format [fadeIn, fadeOut]
Number - duration of the fadeIn/Out effect

tileTransparency: Number - (optional, default 0.3) transparency or alpha value of the tiles. 0 means invisible and 1 fully visible

Return Value:

Boolean - Returns always true

Examples

Example 1:: [parseText "<t font='PuristaBold' size='1.6'>MyMission</t><br />by Username", true, nil, 7, 0.7, 0] spawn BIS_fnc_textTiles;
Example 2:: ["path\to\image.paa"] spawn BIS_fnc_textTiles;

Additional Information

See also:: BIS_fnc_dynamicText BIS_fnc_infoText BIS_fnc_typeText BIS_fnc_typeText2 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

@@ Line 6: / Line 6: @@
 |gr1= GUI
-|descr= Show animated text with background tiles. Can be used to display mission name.<br>
+|eff= local
-[[File:BIS fnc textTiles.gif|left|400px]]
-|s1=[''content'', ''position'', ''tileSize'', ''duration'', ''fadeInOutTime'', ''tileTransparency''] spawn [[BIS_fnc_textTiles]]
+|descr= Shows an animated text with background tiles.<br/> [[File:BIS fnc textTiles.gif|left|400px]]
-|p1= content: [[String]] (picture path) or [[Structured Text]]
+|s1= [content, position, tileSize, duration, fadeInOutTime, tileTransparency] spawn [[BIS_fnc_textTiles]]
-|p2= position: [[Boolean]] optional, default [0,0,1,1] (true = "mission" area in layout options, false = full screen) or [[Array]] (format [X, Y, Width, Height])
-|p3= tileSize: [[Number]] or [[Array]] optional, default 10 ([10,10]) (format [Width, Height])
-|p4= duration: [[Number]] optional, default 5 (in seconds)
-|p5= fadeInOutTime: [[Number]] or [[Array]] [fadeIn, fadeOut] optional, default 0 (in seconds)
-|p6= tileTransparency: [[Number]] optional, default 0.3, '''Where 0 is invisible and 1 is visible, more like an alpha value'''
-|exec= spawn|r1= [[Boolean]]
+|p1= content: [[String]] or [[Structured Text]]
+* [[String]] - path to texure
+* [[Structured Text]] - formatted text
-|x1= <code><nowiki>[</nowiki>[[parseText]] "<t font='PuristaBold' size='1.6'>MyMission</t>&lt;br /&gt;by Username", [[true]], [[nil]], 7, 0.7, 0] [[spawn]] [[BIS_fnc_textTiles]]</code>
+|p2= position: [[Boolean]] or [[Array]] (optional, default [0, 0, 1, 1])
+* [[Boolean]] - [[true]] to use ''mission area'' set in the layout options, [[false]] for full screen
+* [[Array]] - screen space coordinates in format [x, y, w, h]
-|x2= <code>["path\to\image.paa"] [[spawn]] [[BIS_fnc_textTiles]]</code>
+|p3= tileSize: [[Number]] or [[Array]] (optional, default 10 ([10,10])
+* [[Number]] - tile size in screen space coordinates. Tile will be square
+* [[Array]] - tile size in screen space coordinates in format [w, h]
+|p4= duration: [[Number]] - (optional, default 5) duration in seconds
+|p5= fadeInOutTime: [[Number]] or [[Array]] - (optional, default 0) duration of the fade effect in seconds
+* [[Array]] - format [fadeIn, fadeOut]
+* [[Number]] - duration of the fadeIn/Out effect
+|p6= tileTransparency: [[Number]] - (optional, default 0.3) transparency or alpha value of the tiles. 0 means invisible and 1 fully visible
+|r1= [[Boolean]] - Returns always [[true]]
+|exec= spawn
+|x1= <code><nowiki>[</nowiki>[[parseText]] "<t font='PuristaBold' size='1.6'>MyMission</t>&lt;br /&gt;by Username", [[true]], [[nil]], 7, 0.7, 0] [[spawn]] [[BIS_fnc_textTiles]];</code>
+|x2= <code>["path\to\image.paa"] [[spawn]] [[BIS_fnc_textTiles]];</code>
 |seealso= [[BIS_fnc_dynamicText]], [[BIS_fnc_infoText]], [[BIS_fnc_typeText]], [[BIS_fnc_typeText2]], [[BIS_fnc_EXP_camp_SITREP]]
 }}