estimatedTimeLeft: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *E([a-z])" to "$1 - e$2")
 
(70 intermediate revisions by 13 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands]]
{{RV|type=command
[[Category:Scripting Commands OFP 1.97]]
[[Category:Scripting Commands OFP 1.46]]
[[Category:Scripting Commands ArmA]]


back to [[Scripting_Reference#E|COMREF]]
|game1= ofp
|version1= 1.35


<h2 style="color:#000066">'''estimatedTimeLeft ''timeLeft'''''</h2>
|game2= ofpe
|version2= 1.00


|game3= arma1
|version3= 1.00


'''Operand types:'''
|game4= arma2
|version4= 1.00


'''timeLeft:''' [[Number]]
|game5= arma2oa
|version5= 1.50


'''Type of returned value:'''
|game6= tkoh
|version6= 1.00


[[Nothing]]
|game7= arma3
|version7= 0.50


'''Compatibility:'''
|eff= global


Added in version '''1.34'''
|serverExec= server


'''Description:'''
|gr1= Time


Estimated time left in the game.
|gr2= Mission Information


Using this function, designer can provide timeleft estimate that is shown in "Game in progress" screen or in master browser.
|gr3= Multiplayer


For missions with hard set limit adjusted via '''Param1''', following example can be used in '''''init.sqs'''''.
|descr= Sets the estimated time left in the game that is shown in the "Game in progress" screen or in the master browser.
{{Feature|informative|This command will force the server to broadcast [[serverTime]] to all clients without waiting for the next broadcast window (usually every 5 minutes).}}


|s1= [[estimatedTimeLeft]] seconds


'''Example:'''
|p1= seconds: [[Number]] - estimated time in seconds. Maximum value:
* Prior to {{arma3}} v1.70: 7200 seconds (2 hours)
* Since {{arma3}} v1.70: 36000 (10 hours)


'''estimatedTimeLeft''' '''''Param1'''''
|r1= [[Nothing]]
 
|x1= <sqf>estimatedTimeLeft 600; // 10 min</sqf>
 
|x2= '''{{ofp}}:''' for missions with a hard set limit adjusted ''via'' {{Link|Description.ext#param1/param2|param1}}, the following example can be used in the [[Event Scripts#init.sqs|init.sqs]] file:
<sqs>estimatedTimeLeft param1</sqs>
 
|seealso= [[estimatedEndServerTime]] [[serverTime]]
}}

Latest revision as of 14:06, 8 November 2023

Hover & click on the images for description

Description

Description:
Sets the estimated time left in the game that is shown in the "Game in progress" screen or in the master browser.
This command will force the server to broadcast serverTime to all clients without waiting for the next broadcast window (usually every 5 minutes).
Groups:
TimeMission InformationMultiplayer

Syntax

Syntax:
estimatedTimeLeft seconds
Parameters:
seconds: Number - estimated time in seconds. Maximum value:
  • Prior to Arma 3 v1.70: 7200 seconds (2 hours)
  • Since Arma 3 v1.70: 36000 (10 hours)
Return Value:
Nothing

Examples

Example 1:
estimatedTimeLeft 600; // 10 min
Example 2:
Operation Flashpoint: for missions with a hard set limit adjusted via param1, the following example can be used in the init.sqs file:
estimatedTimeLeft param1

Additional Information

See also:
estimatedEndServerTime serverTime

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