BIS fnc countdown: Difference between revisions

Revision as of 18:49, 29 January 2021

1.02

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:: Missions

Syntax

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

Examples

Example 1:: _initialCountDown = [50,false] call BIS_fnc_countDown; // Sets countdown to 50 seconds where function is executed
Example 2:: _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:: _timeLeft = [0] call BIS_fnc_countdown; // Returns the left over-time
Example 5:: _isTimeLeft = [true] call BIS_fnc_countdown; // Returns true if countdown is greater 0

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

@@ Line 1: / Line 1: @@
 {{RV|type=function
-| arma3
+|game1= arma3
-|1.02
+|version1= 1.02
-|gr1 = Missions
+|gr1= Missions
-| Triggers a countdown. {{Informative| The '''initial''' countdown can be accessed via [[missionNamespace]] variable '''bis_fnc_countdown_time'''.<br>The initial value is either ''[[serverTime]] (if set globally) or  [[time]] (if set locally) + timeInSeconds''. To return the left-over time see '''example 4'''}}
+|descr= Triggers a countdown. {{Informative|The '''initial''' countdown can be accessed via [[missionNamespace]] variable '''bis_fnc_countdown_time'''.<br>The initial value is either ''[[serverTime]] (if set globally) or  [[time]] (if set locally) + timeInSeconds''. To return the left-over time see [[#Example_4|Example 4]].}}
-| [timeInSeconds,global] [[call]] '''BIS_fnc_countdown'''
+|s1= [timeInSeconds, global] [[call]] '''BIS_fnc_countdown'''
 |p1= timeInSeconds - Can be:<br>
-[[Number]]:<br>
+* [[Number]]:
-* Any number to set the length of the countdown in seconds
+** Any number to set the length of the countdown in seconds
-* -1 to set the countdown to [[nil]]
+** -1 to set the countdown to [[nil]]
-* 0 to return the left-over time
+** 0 to return the left-over time
-[[Boolean]]:
+*[[Boolean]]:
-* [[true]] to find out if countdown is active and if there is left-over time
+** [[true]] to find out if countdown is active and if there is left-over time
 |p2= global - [[Boolean]]: True to set it globally (Optional) Default: [[true]]
-|[[Number]]:
-* If set locally: [[time]] + timeInSeconds (Example 1)<br>
-* If set globally [[serverTime]] + timeInSeconds (Example 2)
-* Returns -1 if countdown is set to [[nil]] (Example 3)
-* Return left-over time (Example 4)
-[[Boolean]]:<br>
-Returns [[true]] when countdown is > 0 else [[false]] (Example 5)
-|x1= <code>_initialCountDown = [50,[[false]]] [[call]] '''BIS_fnc_countDown''';{{cc|Sets countdown to 50 seconds where function is executed}}</code>
+|r1=<nowiki/>
-|x2= <code>_initialCountDown = [50] [[call]] '''BIS_fnc_countDown''';{{cc|Sets countdown to 50 seconds globally}}</code>
+* [[Number]]:
-|x3= <code>[-1] [[call]] [[BIS_fnc_countdown]]; {{cc|Sets ''bis_fnc_countdown_time'' to [[nil]]}}</code>
+** If set locally: [[time]] + timeInSeconds (Example 1)<br>
-|x4= <code>_timeLeft = [0] [[call]] [[BIS_fnc_countdown]]; {{cc|Returns the left over-time}}</code>
+** If set globally [[serverTime]] + timeInSeconds (Example 2)
-|x5= <code>_isTimeLeft = <noWiki>[</noWiki>[[true]]] [[call]] [[BIS_fnc_countdown]]; {{cc|Returns [[true]] if countdown is greater 0}}</code>
+** Returns -1 if countdown is set to [[nil]] (Example 3)
+** Return left-over time (Example 4)
+* [[Boolean]]: returns [[true]] when countdown is > 0 else [[false]] (see [[#Example_5|Example 5]])
+|x1= <code>_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>
-}}
+|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>
-[[Category:Functions|{{uc:countdown}}]]
+|x5= <code>_isTimeLeft = <noWiki>[</noWiki>[[true]]] [[call]] [[BIS_fnc_countdown]]; {{cc|Returns [[true]] if countdown is greater 0}}</code>
-[[Category:{{Name|arma3}}: Functions|{{uc:countdown}}]]
+}}