BIS fnc textTiles: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (seeAlso edited)
(page refactor)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


|  
| Show animated text with background tiles. Can be used to display mission name. |= Description
<pre>
 
Description:
Show animated text
 
Parameter(s):
0: Content
STRING - Picture
STRUCTURED TEXT - Text
1 (Optional):
ARRAY - Position in format [x,y,w,h]
BOOL - Use "Mission" area position (customizable in Layout options menu)
2 (Optional): ARRAY - Tile size in format [w,h]
3 (Optional): NUMBER - Duration in seconds (default: 5)
4 (Optional): NUMBER - Fade in/out time (default: 0.5)
5 (Optional): NUMBER - Tile transparency (default: 0.3)
 
Returns:
BOOL - true
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_textTiles]]; --> |= Syntax
| [''content'', ''position'', ''tileSize'', ''duration'', ''fadeInOutTime'', ''tileTransparency''] spawn [[BIS_fnc_textTiles]] |= Syntax


|p1= |= Parameter 1
|p1= content: [[String]] (picture path) or [[Structured Text]] |= Parameter 1
|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]) |= Parameter 2
|p3= tileSize: [[Number]] or [[Array]] optional, default 10 ([10,10]) (format [Width, Height]) |= Parameter 3
|p4= duration: [[Number]] optional, default 5 (in seconds) |= Parameter 4
|p5= fadeInOutTime: [[Number]] or [[Array]] [fadeIn, fadeOut] optional, default 0 (in seconds) |= Parameter 5
|p6= tileTransparency: [[Number]] optional, default 0.3 (in range 0..1) |= Parameter 6


| |= Return value
| [[Boolean]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|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> |=  
|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> |=  
____________________________________________________________________________________________
____________________________________________________________________________________________


Revision as of 00:53, 24 January 2018


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

Description

Description:
Show animated text with background tiles. Can be used to display mission name.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[content, position, tileSize, duration, fadeInOutTime, tileTransparency] spawn BIS_fnc_textTiles
Parameters:
content: String (picture path) or Structured Text
position: Boolean optional, default [0,0,1,1] (true = "mission" area in layout options, false = full screen) or Array (format [X, Y, Width, Height])
tileSize: Number or Array optional, default 10 ([10,10]) (format [Width, Height])
duration: Number optional, default 5 (in seconds)
fadeInOutTime: Number or Array [fadeIn, fadeOut] optional, default 0 (in seconds)
tileTransparency: Number optional, default 0.3 (in range 0..1)
Return Value:
Boolean

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_dynamicTextBIS_fnc_infoTextBIS_fnc_typeTextBIS_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_textTiles&oldid=105955"