BIS fnc countdown: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|s([0-9])= ([^ ]+) (\[\[call\]\]) ([^ ]+) " to "|s$1= $2 call $4 ")
m (Text replacement - "bis_fnc_" to "BIS_fnc_")
Line 6: Line 6:
|gr1= Missions
|gr1= Missions


|descr= Triggers a countdown. {{Feature|Informative|The '''initial''' countdown can be accessed via [[missionNamespace]] variable '''bis_fnc_countdown_time'''.<br>
|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 {{HashLink|#Example 4}}.}}
The initial value is either ''[[serverTime]] (if set globally) or  [[time]] (if set locally) + timeInSeconds''. To return the left-over time see {{HashLink|#Example 4}}.}}



Revision as of 18:25, 20 June 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:

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

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