estimatedTimeLeft: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "[[Category:Scripting Commands ArmA|" to "[[Category:Scripting Commands Armed Assault|")
(31 intermediate revisions by 12 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|ESTIMATEDTIMELEFT]]
{{Command|Comments=
[[Category:Scripting Commands OFP 1.96|ESTIMATEDTIMELEFT]]
____________________________________________________________________________________________
[[Category:Scripting Commands OFP 1.46|ESTIMATEDTIMELEFT]]
[[Category:Scripting Commands ArmA|ESTIMATEDTIMELEFT]]


| ofp |Game name=


<h2 style="color:#000066">'''estimatedTimeLeft ''timeLeft'''''</h2>
|1.34|Game version=


|eff= global |Multiplayer Effects=


'''Operand types:'''
|serverExec= server |Server Execution=
____________________________________________________________________________________________


'''timeLeft:''' [[Number]]
| Sets the estimated time left in the game that is shown in the "Game in progress" screen or in the master browser.
{{Informative | This command will force the server to broadcast [[serverTime]] to all clients without waiting for the next broadcast window (usually every 5 minutes).}} |DESCRIPTION=
____________________________________________________________________________________________


'''Type of returned value:'''
| [[estimatedTimeLeft]] seconds |SYNTAX=


[[Nothing]]
|p1= seconds: [[Number]] - estimated time in seconds (maximum 36000 (10 hours) since {{GVI|arma3|1.69}}, 7200 (2 hours) before) |PARAMETER1=


'''Compatibility:'''
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
 
|x1= <code>[[estimatedTimeLeft]] 600; {{cc|10 min}}</code> |EXAMPLE1=


Added in version '''1.34'''  
|x2= '''OFP:''' for missions with a hard set limit adjusted via ''[[Description.ext#titleParam.25.2C_valuesParam.25.2C_defValueParam.25.2C_textParam.25|param1]]'', the following example can be used in the [[Event Scripts|init.sqs]] file:
<code>[[estimatedTimeLeft]] param1;</code>|EXAMPLE2=
____________________________________________________________________________________________


'''Description:'''
| [[estimatedEndServerTime]], [[serverTime]] |SEEALSO=
}}


Estimated time left in the game.
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->


Using this function, designer can provide timeleft estimate that is shown in "Game in progress" screen or in master browser.
<!-- Note Section END -->
</dl>


For missions with hard set limit adjusted via '''Param1''', following example can be used in '''''init.sqs'''''.
<h3 style="display:none">Bottom Section</h3>


 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
'''Example:'''
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
'''estimatedTimeLeft''' ''Param1''
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Armed Assault|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Mission_Information|{{uc:{{PAGENAME}}}}]]

Revision as of 20:18, 3 June 2020

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

Syntax

Syntax:
estimatedTimeLeft seconds
Parameters:
seconds: Number - estimated time in seconds (maximum 36000 (10 hours) since Arma 3 logo black.png1.69, 7200 (2 hours) before)
Return Value:
Nothing

Examples

Example 1:
estimatedTimeLeft 600; // 10 min
Example 2:
OFP: 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:
estimatedEndServerTimeserverTime

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

Notes

Bottom Section