BIS fnc WLSmoothText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "{{Function|= Comments | arma3 |Game name= |1.88|Game version= <!---|arg= local |Multiplayer Arguments=---> <!---|eff= local |Multiplayer Effects=---> | <pre>/* Author: Jo...")
 
m (Text replacement - "\|seealso= ?\[\[([^ ]+)\]\], *\[\[([^ ]+)\]\]" to "|seealso= $1 $2")
(28 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.86


|1.88|Game version=
|gr1= Warlords


<!---|arg= local |Multiplayer Arguments=--->
|gr2= GUI


<!---|eff= local |Multiplayer Effects=--->
|eff= local


| <pre>/*
|descr= Display given text smoothly.
Author: Josef Zemánek


Parameters: 0 - Text (String)
|s1= [text, nbOfLines, duration, color, outline] call [[BIS_fnc_WLSmoothText]]
1 - Max number of lines to be shown at the same time (Number)
2 - On-screen duration (Number)
3 - Text color (Array [R,G,B,A])
4 - Text outline (Bool)


Description: Eye-candy text effect.
|p1= text: [[String]] - text to display
*/</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=


|[] call [[BIS_fnc_WLSmoothText]]|Syntax=
|p2= nbOfLines: [[Number]] - (Optional, default 3) maximum number of lines to be shown at the same time


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|p3= duration: [[Number]] - (Optional, default 5) on-screen duration


|Datatype - description|Return value=
|p4= color: [[Color|Color (RGBA)]] - (Optional, default [1,1,1,1]) text color


|x1= <code></code>|Example 1=
|p5= outline: [[Boolean]] - (Optional, default [[true]]) [[true]] to outline the text, [[false]] not to


|exec= call |Execution=
|r1= [[Nothing]]


| |See also=
|x1= <code>["Hello, hidden FX", 2, 3, [1,0,0,1], [[true]]] [[spawn]] [[BIS_fnc_WLSmoothText]]; {{cc|no sounds, letters appear in a smooth transition}}</code>
 
|exec= spawn
 
|seealso= [[Arma 3: Notification]] [[BIS_fnc_titleText]], [[BIS_fnc_typeText]], [[BIS_fnc_typeText2]]
}}
}}
[[Category:Function Group: Misc|{{uc:WLSmoothText}}]]
[[Category:Functions|{{uc:WLSmoothText}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:WLSmoothText}}]]

Revision as of 23:38, 20 January 2022

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

Description

Description:
Display given text smoothly.
Execution:
spawn
Groups:
WarlordsGUI

Syntax

Syntax:
[text, nbOfLines, duration, color, outline] call BIS_fnc_WLSmoothText
Parameters:
text: String - text to display
nbOfLines: Number - (Optional, default 3) maximum number of lines to be shown at the same time
duration: Number - (Optional, default 5) on-screen duration
color: Color (RGBA) - (Optional, default [1,1,1,1]) text color
outline: Boolean - (Optional, default true) true to outline the text, false not to
Return Value:
Nothing

Examples

Example 1:
["Hello, hidden FX", 2, 3, [1,0,0,1], true] spawn BIS_fnc_WLSmoothText; // no sounds, letters appear in a smooth transition

Additional Information

See also:
Arma 3: Notification BIS_fnc_titleTextBIS_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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_WLSmoothText&oldid=308016"