BIS fnc countdown: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (page overhaul)
m (format)
Line 14: Line 14:


|p1= timeInSeconds - [[Number]]: Length of the countdown in seconds |PARAMETER1=
|p1= timeInSeconds - [[Number]]: Length of the countdown in seconds |PARAMETER1=
|p2= global - [[Boolean]]: True to set it globally (Optional) Default: true |PARAMETER2=
|p2= global - [[Boolean]]: True to set it globally (Optional) Default: [[true]] |PARAMETER2=
|[[Number]]:  
|[[Number]]:  
* If set locally: [[time]] + timeInSeconds (Example 1)<br>
* If set locally: [[time]] + timeInSeconds (Example 1)<br>

Revision as of 09:15, 28 September 2019


Hover & click on the images for description

Description

Description:
Triggers a countdown.
The initial countdown can be accessed via missionNamespace variable bis_fnc_countdown_time.
The initial value is either serverTime (if set globally) or time (if set locally) + timeInSeconds. To return the left-over time see example 4
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[timeInSeconds,global] call BIS_fnc_countdown
Parameters:
timeInSeconds - Number: Length of the countdown in seconds
global - Boolean: True to set it globally (Optional) Default: true
Return Value:
Number:
  • If set locally: time + timeInSeconds (Example 1)
  • If set globally serverTime + timeInSeconds
  • Returns -1 if countdown is set to nil (Example 3)
Boolean:
Returns true when countdown is > 0 else false (Example 2)

Examples

Example 1:
_countDown = [50,true] call BIS_fnc_countDown;// Sets countdown to 50 seconds globally
Example 2:
[true] call BIS_fnc_countdown; // Returns true if countdown is greater 0
Example 3:
[-1] call BIS_fnc_countdown; // Sets bis_fnc_countdown_time to nil
Example 4:
[0] call BIS_fnc_countdown; // Returns the left over-time

Additional Information

See also:
See also needed

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

Notes

Bottom Section