BIS fnc countdown: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Function|Comments= | {{Function|Comments= | ||
| arma3 |Game name= | | arma3 |Game name= | ||
| Line 7: | Line 6: | ||
|gr1 = Missions |GROUP1= | |gr1 = Missions |GROUP1= | ||
| 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'''}}|DESCRIPTION= | | 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'''}}|DESCRIPTION= | ||
| [timeInSeconds,global] [[call]] '''BIS_fnc_countdown''' |SYNTAX= | | [timeInSeconds,global] [[call]] '''BIS_fnc_countdown''' |SYNTAX= | ||
| Line 29: | Line 26: | ||
[[Boolean]]:<br> | [[Boolean]]:<br> | ||
Returns [[true]] when countdown is > 0 else [[false]] (Example 5) |RETURNVALUE= | Returns [[true]] when countdown is > 0 else [[false]] (Example 5) |RETURNVALUE= | ||
|x1= <code>_initialCountDown = [50,[[false]]] [[call]] '''BIS_fnc_countDown''';{{cc|Sets countdown to 50 seconds where function is executed}}</code> |EXAMPLE1= | |x1= <code>_initialCountDown = [50,[[false]]] [[call]] '''BIS_fnc_countDown''';{{cc|Sets countdown to 50 seconds where function is executed}}</code> |EXAMPLE1= | ||
| Line 38: | Line 34: | ||
||SEEALSO= | ||SEEALSO= | ||
Revision as of 22:34, 16 January 2021
Description
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
- 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)
Returns true when countdown is > 0 else false (Example 5) - If set locally: time + timeInSeconds (Example 1)
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