BIS fnc countdown: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Text replacement - "\{\{( *)Informative( *)\|" to "{{$1Feature$2|$2Informative$2|")
Line 7: Line 7:
|gr1= Missions
|gr1= Missions


|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]].}}
|descr= Triggers a countdown. {{Feature|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]].}}


|s1= [timeInSeconds, global] [[call]] '''BIS_fnc_countdown'''
|s1= [timeInSeconds, global] [[call]] '''BIS_fnc_countdown'''

Revision as of 01:00, 7 February 2021

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