BIS fnc EXP camp SITREP: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|game([0-9])=([^ ]+) * \|version([0-9])=([^ ]+) * " to "|game$1=$2 |version$3=$4 ")
(formatting)
Line 10: Line 10:
|eff= local
|eff= local


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


|s1= [line, fadeInTime, waitTime, fadeOutTime] spawn [[BIS_fnc_EXP_camp_SITREP]]
|s1= [line_1, line_2, line_n] spawn [[BIS_fnc_EXP_camp_SITREP]]


|p1= line: [[String]] - Contents of the line to be displayed
|p1= line_1-n: [[Array]] - lines to be displayed. Each array consist of the following parameters:
* 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


|p2= fadeInTime: [[Number]] - Fade-in duration in seconds (Optional, default 2)
|r1= [[Boolean]] - [[true]] if successful, [[false]] if not


|p3= waitTime: [[Number]] - How long it should wait before showing the next line (Optional, default 1)
|x1= <code>[["line1", 4, 5], ["line2", 3, 5, 8]] [[spawn]] [[BIS_fnc_EXP_camp_SITREP]];</code>
 
|p4= fadeOutTime: [[String]] - Fade-out duration (only used by the last line, fades all other lines as well) (Optional, default 2)
 
|r1= [[Boolean]] - [[true|True]] if successful, [[false]] if not
 
|x1= <code>[["line1",4,5],["line2",3,5,8]] [[spawn]] [[BIS_fnc_EXP_camp_SITREP]];</code>


|exec= spawn
|exec= spawn

Revision as of 16:41, 18 August 2021

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

Description

Description:
Displays multiple lines of text in given order.
  • Each array you pass represents a line that should be displayed
  • Lines will be displayed in the order you define them
BIS fnc EXP camp SITREP.gif
Execution:
spawn
Groups:
CampaignGUI

Syntax

Syntax:
[line_1, line_2, line_n] spawn BIS_fnc_EXP_camp_SITREP
Parameters:
line_1-n: Array - lines to be displayed. Each array consist of the following parameters:
  • 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_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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_EXP_camp_SITREP&oldid=293131"