BIS fnc textTiles: Difference between revisions

Latest revision as of 15:47, 8 November 2023

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 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= GUI
-|1.00|= Game version
+|eff= local
-____________________________________________________________________________________________
-|
+|descr= [[File:BIS_fnc_textTiles.gif|right|400px]]
-<pre>
+Shows an animated text with background tiles.
-	Description:
+|s1= [content, position, tileSize, duration, fadeInOutTime, tileTransparency] spawn [[BIS_fnc_textTiles]]
-	Show animated text
-	Parameter(s):
+|p1= content: [[String]] or [[Structured Text]]
-: Content
+* [[String]] - path to texure
-		STRING - Picture
+* [[Structured Text]] - formatted text
-		STRUCTURED TEXT - Text
-(Optional):
-		ARRAY - Position in format [x,y,w,h]
-		BOOL - Use "Mission" area position (customizable in Layout options menu)
-(Optional): ARRAY - Tile size in format [w,h]
-(Optional): NUMBER - Duration in seconds (default: 5)
-(Optional): NUMBER - Fade in/out time (default: 0.5)
-(Optional): NUMBER - Tile transparency (default: 0.3)
-	Returns:
+|p2= position: [[Boolean]] or [[Array]] (optional, default [0, 0, 1, 1])
-	BOOL - true
+* [[Boolean]] - [[true]] to use ''mission area'' set in the layout options, [[false]] for full screen
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+* [[Array]] - screen space coordinates in format [x, y, w, h]
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_textTiles]]; --> |= Syntax
+|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]
-|p1= |= Parameter 1
+|p4= duration: [[Number]] - (optional, default 5) duration in seconds
-| |= Return value
+|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
-|x1= <code><nowiki>[</nowiki>[[parseText]] [[format]] [ "<t align='right' size='1.2'><t font='PuristaBold' size='1.6'>""%1""</t><br />%2</t>", [[toUpper]] "Mission Name", "by Mission Author"], [[true]], [[nil]], 7, 0.7, 0] [[spawn]] [[BIS_fnc_textTiles]];</code> |=
+|p6= tileTransparency: [[Number]] - (optional, default 0.3) transparency or alpha value of the tiles. 0 means invisible and 1 fully visible
-____________________________________________________________________________________________
-| [[BIS_fnc_dynamicText]], [[BIS_fnc_infoText]], [[BIS_fnc_typeText]], [[BIS_fnc_typeText2]] |= See also
+|r1= [[Boolean]] - returns always [[true]]
-}}
+|exec= spawn
-<h3 style="display:none">Notes</h3>
+|x1= <sqf>[parseText "<t font='PuristaBold' size='1.6'>MyMission</t><br />by Username", true, nil, 7, 0.7, 0] spawn BIS_fnc_textTiles;</sqf>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|x2= <sqf>["path\to\image.paa"] spawn BIS_fnc_textTiles;</sqf>
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|seealso= [[BIS_fnc_dynamicText]] [[BIS_fnc_infoText]] [[BIS_fnc_typeText]] [[BIS_fnc_typeText2]] [[BIS_fnc_EXP_camp_SITREP]]
-[[Category:Function Group: GUI|{{uc:textTiles}}]]
+}}
-[[Category:Functions|{{uc:textTiles}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:textTiles}}]]