BIS fnc countdown: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "|= Game version" to "|Game version=") |
m (page overhaul) |
||
| Line 8: | Line 8: | ||
___________________________________________________________________________________________ | ___________________________________________________________________________________________ | ||
| Triggers a countdown. | | 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= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 15: | Line 15: | ||
|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]]: Returns | |[[Number]]: | ||
* If set locally: [[time]] + timeInSeconds (Example 1)<br> | |||
* If set globally [[serverTime]] + timeInSeconds | |||
* Returns -1 if countdown is set to [[nil]] (Example 3) | |||
[[Boolean]]:<br> | |||
Returns [[true]] when countdown is > 0 else [[false]] (Example 2) |RETURNVALUE= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>_countDown = [50, | |x1= <code>_countDown = [50,[[true]]] [[call]] '''BIS_fnc_countDown''';{{cc|Sets countdown to 50 seconds globally}}</code> |EXAMPLE1= | ||
|x2= <code><noWiki>[</noWiki>[[true]]] [[call]] [[BIS_fnc_countdown]]; {{cc|Returns [[true]] if countdown is greater 0}}</code> |EXAMPLE2= | |||
|x3= <code>[-1] [[call]] [[BIS_fnc_countdown]]; {{cc|Sets ''bis_fnc_countdown_time'' to [[nil]]}}</code> |EXAMPLE3= | |||
|x4= <code>[0] [[call]] [[BIS_fnc_countdown]]; {{cc|Returns the left over-time}}</code> |EXAMPLE4= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 09:14, 28 September 2019
Description
- Description:
- Triggers a countdown.
- 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)
Returns true when countdown is > 0 else false (Example 2) - If set locally: time + timeInSeconds (Example 1)
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