BIS fnc countdown: Difference between revisions

Revision as of 13:07, 6 May 2022

Hover & click on the images for 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:: Missions

Syntax:

[timeInSeconds, global] call BIS_fnc_countdown

Parameters:

timeInSeconds - can be:

Number:
- Any number to set the length of the countdown in seconds
- -1 to set the countdown to nil
- 0 to return the left-over time
Boolean:
- true to find out if countdown is active and if there is left-over time

global - Boolean: True to set it globally (Optional) Default: true

Return Value:

Number:
- If set locally: time + timeInSeconds (see Example 1)
- If set globally serverTime + timeInSeconds (see Example 2)
- Returns -1 if countdown is set to nil (see Example 3)
- Return left-over time (see Example 4)
Boolean: returns true when countdown is > 0 else false (see Example 5)

Example 1:: private _initialCountdown = [50,false] call BIS_fnc_countdown; // sets countdown to 50 seconds where function is executed
Example 2:: private _initialCountdown = [50] call BIS_fnc_countdown; // sets countdown to 50 seconds globally
Example 3:: [-1] call BIS_fnc_countdown; // sets BIS_fnc_countdown_time to nil
Example 4:: private _timeLeft = [0] call BIS_fnc_countdown; // returns the left over-time
Example 5:: private _isTimeLeft = [true] call BIS_fnc_countdown; // returns true if countdown is greater 0

: 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 29: / Line 29: @@
 * [[Boolean]]: returns [[true]] when countdown is > 0 else [[false]] (see {{HashLink|#Example 5}})
-|x1= <code>_initialCountdown = [50,[[false]]] [[call]] [[BIS_fnc_countdown]]; {{cc|sets countdown to 50 seconds where function is executed}}</code>
+|x1= <code>[[private]] _initialCountdown = [50,[[false]]] [[call]] [[BIS_fnc_countdown]]; {{cc|sets countdown to 50 seconds where function is executed}}</code>
-|x2= <code>_initialCountdown = [50] [[call]] [[BIS_fnc_countdown]]; {{cc|sets countdown to 50 seconds globally}}</code>
+|x2= <code>[[private]] _initialCountdown = [50] [[call]] [[BIS_fnc_countdown]]; {{cc|sets countdown to 50 seconds globally}}</code>
 |x3= <code>[-1] [[call]] [[BIS_fnc_countdown]]; {{cc|sets ''BIS_fnc_countdown_time'' to [[nil]]}}</code>
-|x4= <code>_timeLeft = [0] [[call]] [[BIS_fnc_countdown]]; {{cc|returns the left over-time}}</code>
+|x4= <code>[[private]] _timeLeft = [0] [[call]] [[BIS_fnc_countdown]]; {{cc|returns the left over-time}}</code>
-|x5= <code>_isTimeLeft = <noWiki>[</noWiki>[[true]]] [[call]] [[BIS_fnc_countdown]]; {{cc|returns [[true]] if countdown is greater 0}}</code>
+|x5= <code>[[private]] _isTimeLeft = <noWiki>[</noWiki>[[true]]] [[call]] [[BIS_fnc_countdown]]; {{cc|returns [[true]] if countdown is greater 0}}</code>
 |seealso= [[BIS_fnc_VRTimer]]
 }}