BIS fnc textTiles: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2")
 
(36 intermediate revisions by 2 users not shown)
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
____________________________________________________________________________________________


| Show animated text with background tiles. Can be used to display mission name.[[File:BIS fnc textTiles.gif|left|400px]]|DESCRIPTION=
|descr= [[File:BIS_fnc_textTiles.gif|right|400px]]
____________________________________________________________________________________________
Shows an animated text with background tiles.


| [''content'', ''position'', ''tileSize'', ''duration'', ''fadeInOutTime'', ''tileTransparency''] spawn [[BIS_fnc_textTiles]] |SYNTAX=
|s1= [content, position, tileSize, duration, fadeInOutTime, tileTransparency] spawn [[BIS_fnc_textTiles]]


|p1= content: [[String]] (picture path) or [[Structured Text]] |PARAMETER1=
|p1= content: [[String]] or [[Structured Text]]
|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]) |PARAMETER2=
* [[String]] - path to texure
|p3= tileSize: [[Number]] or [[Array]] optional, default 10 ([10,10]) (format [Width, Height]) |PARAMETER3=
* [[Structured Text]] - formatted text
|p4= duration: [[Number]] optional, default 5 (in seconds) |PARAMETER4=
|p5= fadeInOutTime: [[Number]] or [[Array]] [fadeIn, fadeOut] optional, default 0 (in seconds) |PARAMETER5=
|p6= tileTransparency: [[Number]] optional, default 0.3, '''Where 0 is invisible and 1 is visible, more like an alpha value''' |PARAMETER6=


|exec= spawn |= Execution
|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]


| [[Boolean]] |RETURNVALUE=
|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]


|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> |=
|p4= duration: [[Number]] - (optional, default 5) duration in seconds
|x2= <code>["path\to\image.paa"] [[spawn]] [[BIS_fnc_textTiles]]</code> |=
____________________________________________________________________________________________


| [[BIS_fnc_dynamicText]], [[BIS_fnc_infoText]], [[BIS_fnc_typeText]], [[BIS_fnc_typeText2]], [[BIS_fnc_EXP_camp_SITREP]] |SEEALSO=
|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


<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}}]]

Latest revision as of 16:47, 8 November 2023

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

Description

Description:
BIS fnc textTiles.gif
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
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_textTiles&oldid=349016"