BIS fnc EXP camp SITREP: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Some wiki formatting)
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.62


|1.62|Game version=
|gr1= Campaign


|gr1 = Campaign |GROUP1=
|gr2= GUI


|gr2 = GUI |GROUP2=
|eff= local


| Display situation text, typically used at the start of a mission.
|descr= Displays multiple lines of text in given order.<br>
*Each array you pass represents a line that should be displayed
[[File:BIS_fnc_EXP camp SITREP.gif|400px]]
*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=
|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


|r1= [[Boolean]] - [[true]] if successful, [[false]] if not


|x1= <sqf>[["line1", 4, 5], ["line2", 3, 5, 8]] spawn BIS_fnc_EXP_camp_SITREP;</sqf>


|p1= line: [[String]] - Contents of the line to be displayed |PARAMETER1=
|exec= spawn
 
|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) |PARAMETER3=
 
|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=
 
|x1= <code>[["line1",4,5],["line2",3,5,8]] [[spawn]] '''BIS_fnc_EXP_camp_SITREP''';</code> |EXAMPLE1=
 
|exec= spawn |Execution=
 
| [[BIS_fnc_dynamicText]], [[BIS_fnc_infoText]], [[BIS_fnc_textTiles]], [[BIS_fnc_typeText2]] |SEEALSO=


|seealso= [[BIS_fnc_dynamicText]] [[BIS_fnc_infoText]] [[BIS_fnc_textTiles]] [[BIS_fnc_typeText2]]
}}
}}

Latest revision as of 16:05, 30 January 2023

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

Description

Description:
Displays multiple lines of text in given order.
BIS fnc EXP camp SITREP.gif
Execution:
spawn
Groups:
CampaignGUI

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_EXP_camp_SITREP&oldid=337428"