BIS fnc EXP camp SITREP: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (template:command argument fix)
Line 19: Line 19:




|p1= line: [[String]] - Contents of the line to be displayed |= Parameter 1
|p1= line: [[String]] - Contents of the line to be displayed |PARAMETER1=


|p2= fadeInTime: [[Number]] - Fade-in duration in seconds (Optional, default 2) |= Parameter 2
|p2= fadeInTime: [[Number]] - Fade-in duration in seconds (Optional, default 2) |PARAMETER2=


|p3= waitTime: [[Number]] - How long it should wait before showing the next line (Optional, default 1) |= Parameter 3
|p3= waitTime: [[Number]] - How long it should wait before showing the next line (Optional, default 1) |PARAMETER3=


|p4= fadeOutTime: [[String]] - Fade-out duration (only used by the last line, fades all other lines as well) (Optional, default 2)|= Parameter 4
|p4= fadeOutTime: [[String]] - Fade-out duration (only used by the last line, fades all other lines as well) (Optional, default 2)|PARAMETER4=


| [[Boolean]] - [[true|True]] if successful, [[false]] if not |RETURNVALUE=
| [[Boolean]] - [[true|True]] if successful, [[false]] if not |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>[["line1",4,5],["line2",3,5,8]] [[spawn]] '''BIS_fnc_EXP_camp_SITREP''';</code> |= Example 1
|x1= <code>[["line1",4,5],["line2",3,5,8]] [[spawn]] '''BIS_fnc_EXP_camp_SITREP''';</code> |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 14:30, 7 April 2019

Hover & click on the images for description

Description

Description:
Display situation text, typically used at the start of a mission.
  • 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
BIS fnc EXP camp SITREP.gif
Execution:
spawn
Groups:
Uncategorised

Syntax

Syntax:
[line, fadeInTime, waitTime, fadeOutTime] spawn BIS_fnc_EXP_camp_SITREP
Parameters:
line: String - Contents of the line to be displayed
fadeInTime: Number - Fade-in duration in seconds (Optional, default 2)
waitTime: Number - How long it should wait before showing the next line (Optional, default 1)
fadeOutTime: String - Fade-out duration (only used by the last line, fades all other lines as well) (Optional, default 2)
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_dynamicTextBIS_fnc_infoTextBIS_fnc_textTilesBIS_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