BIS fnc EXP camp SITREP: Difference between revisions

Latest revision as of 15:05, 30 January 2023

1.62

LELocal

Hover & click on the images for description

Description

Description:: Displays multiple lines of text in given order.
Execution:: spawn
Groups:: Campaign GUI

Syntax

Syntax:

[line1, line2, lineX] spawn BIS_fnc_EXP_camp_SITREP

Parameters:

line#: Array - lines to be displayed, format [text, fadeInTime, waitTime, fadeOutTime]:

0: text: String - text to be displayed
1: fadeInTime: Number - (Optional, default 2) fade-in duration in seconds
2: waitTime: Number - (Optional, default 1) how many seconds to wait before showing the next line
3: fadeOutTime: String - (Optional, default 2) fade-out duration in seconds. It is only used by the last line. Fades all other lines as well

Return Value:

Boolean - true if successful, false if not

Examples

Example 1:: [["line1", 4, 5], ["line2", 3, 5, 8]] spawn BIS_fnc_EXP_camp_SITREP;

Additional Information

See also:: BIS_fnc_dynamicText BIS_fnc_infoText BIS_fnc_textTiles BIS_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

@@ Line 1: / Line 1: @@
-{{Function|= Comments
+{{RV|type=function
-____________________________________________________________________________________________
-| arma3 |= Game name
+|game1= arma3
+|version1= 1.62
-|1.62|= Game version
+|gr1= Campaign
-____________________________________________________________________________________________
-| Display situation text, typically used at the start of a mission.
+|gr2= GUI
-*Each array you pass represents a line that should be displayed
-*Lines will be displayed in the order you define them
-*Each line's array consists of the following information
-[[File:BIS fnc EXP camp SITREP.gif|left|400px]]|= Description
-____________________________________________________________________________________________
-| [line, fadeInTime, waitTime, fadeOutTime] spawn  '''BIS_fnc_EXP_camp_SITREP''' |= Syntax
+|eff= local
+|descr= Displays multiple lines of text in given order.<br>
+[[File:BIS_fnc_EXP camp SITREP.gif|400px]]
+|s1= [line1, line2, lineX] spawn [[BIS_fnc_EXP_camp_SITREP]]
+|p1= line#: [[Array]] - lines to be displayed, format [text, fadeInTime, waitTime, fadeOutTime]:
+* 0: text: [[String]] - text to be displayed
+* 1: fadeInTime: [[Number]] - (Optional, default 2) fade-in duration in seconds
+* 2: waitTime: [[Number]] - (Optional, default 1) how many seconds to wait before showing the next line
+* 3: fadeOutTime: [[String]] - (Optional, default 2) fade-out duration in seconds. It is only used by the last line. Fades all other lines as well
-|p1= line: [[String]] - Contents of the line to be displayed |= Parameter 1
+|r1= [[Boolean]] - [[true]] if successful, [[false]] if not
-|p2= fadeInTime: [[Number]] - Fade-in duration in seconds (Optional, default 2) |= Parameter 2
+|x1= <sqf>[["line1", 4, 5], ["line2", 3, 5, 8]] spawn BIS_fnc_EXP_camp_SITREP;</sqf>
-|p3= waitTime: [[Number]] - How long it should wait before showing the next line (Optional, default 1) |= Parameter 3
+|exec= spawn
-|p4= fadeOutTime: [[String]] - Fade-out duration (only used by the last line, fades all other lines as well) (Optional, default 2)|= Parameter 4
-| [[Boolean]] - [[true|True]] if successful, [[false]] if not |= Return value
-____________________________________________________________________________________________
-|x1= <code>[["line1",4,5],["line2",3,5,8]] [[spawn]] '''BIS_fnc_EXP_camp_SITREP''';</code> |= Example 1
-____________________________________________________________________________________________
-|exec= spawn |= Execution
-| [[BIS_fnc_dynamicText]], [[BIS_fnc_infoText]], [[BIS_fnc_textTiles]], [[BIS_fnc_typeText2]] |= See also
+|seealso= [[BIS_fnc_dynamicText]] [[BIS_fnc_infoText]] [[BIS_fnc_textTiles]] [[BIS_fnc_typeText2]]
 }}