estimatedTimeLeft: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
 
m (template:command argument fix)
(27 intermediate revisions by 11 users not shown)
Line 1: Line 1:
<h2 style="color:#000066">'''estimatedTimeLeft ''timeLeft'''''</h2>
{{Command|= Comments
____________________________________________________________________________________________


'''Operand types:'''
| a3 |= Game name


timeLeft: [[Number]]
|1.34|= Game version


'''Type of returned value:'''
|eff= global |= Effects in MP


Nothing
|exec= server |=
____________________________________________________________________________________________


'''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 also force the server to broadcast [[serverTime]] to all clients ASAP, without waiting for the next broadcast window, which is about every 5 minutes.|DESCRIPTION=
____________________________________________________________________________________________


Estimated time left in the game.
| '''estimatedTimeLeft''' seconds|SYNTAX=
Using this function, designer can provide timeleft estimate that is shown in "Game in progress" screen or in master browser.
For missions with hard set limit adjusted via Param1, following example can be used in init.sqs.


'''Example:'''
|p1= seconds: [[Number]] - estimated time in seconds (7200 sec max, since {{GVI|arma3|1.69}} the limit is 36000 seconds). |PARAMETER1=


'''estimatedTimeLeft''' Param1
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
 
|x1= <code>[[estimatedTimeLeft]] 600; //10 min</code>  |EXAMPLE1=
 
|x2= For missions with a hard set limit adjusted via Param1, the following example can be used in the init.sqs file:<code>[[estimatedTimeLeft]] Param1;</code>|EXAMPLE2=
____________________________________________________________________________________________
 
|mp= Has to be executed on the server. Effect is global. |=
 
| [[estimatedEndServerTime]], [[serverTime]] |SEEALSO=
 
}}
 
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
 
<!-- Note Section END -->
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|ESTIMATEDTIMELEFT]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|ESTIMATEDTIMELEFT]]
[[Category:Scripting Commands OFP 1.46|ESTIMATEDTIMELEFT]]
[[Category:Scripting Commands ArmA|ESTIMATEDTIMELEFT]]
[[Category:Command_Group:_Mission_Information|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Revision as of 15:39, 7 April 2019

-wrong parameter ("a3") defined!-[[:Category:Introduced with a3 version 1.34|1.34]]
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 also force the server to broadcast serverTime to all clients ASAP, without waiting for the next broadcast window, which is about every 5 minutes.
Multiplayer:
Has to be executed on the server. Effect is global.
Groups:
Uncategorised

Syntax

Syntax:
estimatedTimeLeft seconds
Parameters:
seconds: Number - estimated time in seconds (7200 sec max, since Arma 3 logo black.png1.69 the limit is 36000 seconds).
Return Value:
Nothing

Examples

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

[[Category:Introduced with a3 version 1.34]][[ Category: a3: New Scripting Commands | ESTIMATEDTIMELEFT]][[ Category: a3: Scripting Commands | ESTIMATEDTIMELEFT]]

Notes

Bottom Section