Difference between revisions of "BIS fnc countdown"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (page formatting)
 
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
  
{{Function|= Comments
+
{{Function|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| arma3 |= Game name
+
| arma3 |Game name=
  
|1.00|= Game version
+
|1.02|Game version=
 +
___________________________________________________________________________________________
 +
 
 +
| 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=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| <pre>/*
+
| [timeInSeconds,global] [[call]] '''BIS_fnc_countdown''' |SYNTAX=
  
Description:
+
|p1= timeInSeconds - Can be:<br>
Trigger countdown
+
[[Number]]:<br>
 
+
* Any number to set the length of the countdown in seconds
Parameter(s):
+
* -1 to set the countdown to [[nil]]
0: NUMBER - countdown in seconds
+
* 0 to return the left-over time
1: BOOL - true to set the value globally
+
[[Boolean]]:
 
+
* [[True]] to find out if countdown is active and if there is left-over time |PARAMETER1=
Returns:
+
|p2= global - [[Boolean]]: True to set it globally (Optional) Default: [[true]] |PARAMETER2=
NUMBER
+
|[[Number]]:
*/
+
* If set locally: [[time]] + timeInSeconds (Example 1)<br>
 
+
* If set globally [[serverTime]] + timeInSeconds (Example 2)
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+
* Returns -1 if countdown is set to [[nil]] (Example 3)
 +
* Return left-over time (Example 4)
 +
[[Boolean]]:<br>
 +
Returns [[true]] when countdown is > 0 else [[false]] (Example 5) |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| <!-- [] call [[BIS_fnc_countdown]]; --> |= Syntax
+
|x1= <code>_initialCountDown = [50,[[false]]] [[call]] '''BIS_fnc_countDown''';{{cc|Sets countdown to 50 seconds where function is executed}}</code> |EXAMPLE1=
 +
|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=
 +
|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=
  
|p1= |= Parameter 1
 
  
| |= Return value
 
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|x1= <code></code> |=  
+
||SEEALSO=
____________________________________________________________________________________________
 
  
| |= See also
 
  
 
}}
 
}}

Latest revision as of 09:17, 28 September 2019

Introduced with Arma 3 version 1.02
  

Click on the images for descriptions

Introduced in

Game:
Arma 3
Version:
1.02

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

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 (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

Execution:
call
Multiplayer:
-
See also:
See also needed

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section