BIS fnc countdown: Difference between revisions
Jump to navigation
Jump to search
m (example) |
m (page formatting) |
||
Line 13: | Line 13: | ||
| [timeInSeconds,global] [[call]] '''BIS_fnc_countdown''' |SYNTAX= | | [timeInSeconds,global] [[call]] '''BIS_fnc_countdown''' |SYNTAX= | ||
|p1= timeInSeconds - [[Number]]: | |p1= timeInSeconds - Can be:<br> | ||
[[Number]]:<br> | |||
* 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 |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> | ||
* If set globally [[serverTime]] + timeInSeconds | * If set globally [[serverTime]] + timeInSeconds (Example 2) | ||
* Returns -1 if countdown is set to [[nil]] (Example 3) | * Returns -1 if countdown is set to [[nil]] (Example 3) | ||
* Return left-over time (Example 4) | |||
[[Boolean]]:<br> | [[Boolean]]:<br> | ||
Returns [[true]] when countdown is > 0 else [[false]] (Example | Returns [[true]] when countdown is > 0 else [[false]] (Example 5) |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>_initialCountDown = [50,[[ | |x1= <code>_initialCountDown = [50,[[false]]] [[call]] '''BIS_fnc_countDown''';{{cc|Sets countdown to 50 seconds where function is executed}}</code> |EXAMPLE1= | ||
|x2= <code> | |x2= <code>_initialCountDown = [50] [[call]] '''BIS_fnc_countDown''';{{cc|Sets countdown to 50 seconds globally}}</code> |EXAMPLE2= | ||
|x3= <code>[-1] [[call]] [[BIS_fnc_countdown]]; {{cc|Sets ''bis_fnc_countdown_time'' to [[nil]]}}</code> |EXAMPLE3= | |x3= <code>[-1] [[call]] [[BIS_fnc_countdown]]; {{cc|Sets ''bis_fnc_countdown_time'' to [[nil]]}}</code> |EXAMPLE3= | ||
|x4= <code>_timeLeft = [0] [[call]] [[BIS_fnc_countdown]]; {{cc|Returns the left over-time}}</code> |EXAMPLE4= | |x4= <code>_timeLeft = [0] [[call]] [[BIS_fnc_countdown]]; {{cc|Returns the left over-time}}</code> |EXAMPLE4= | ||
|x5= <code>_isTimeLeft = <noWiki>[</noWiki>[[true]]] [[call]] [[BIS_fnc_countdown]]; {{cc|Returns [[true]] if countdown is greater 0}}</code> |EXAMPLE5= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 09:17, 28 September 2019
Description
- Description:
- Triggers a countdown.
- Execution:
- call
- Groups:
- Uncategorised
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