Difference between revisions of "setTimeMultiplier"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
(47 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| arma3 |= Game name
+
|game1= arma3
 +
|version1= 1.26
  
|1.26|= Game version
+
|eff= global
____________________________________________________________________________________________
 
  
| Sets a time multiplier for in-game time. |= Description
+
|gr1= Time
____________________________________________________________________________________________
 
  
| '''setTimeMultiplier''' value|= Syntax
+
|gr2= Mission Information
  
|p1= value: [[Number]]. |= Parameter 1
+
|gr3= Environment
  
 +
|serverExec= server
  
| [[Nothing]] |= RETURNVALUE
+
|descr= Sets a time multiplier for in-game time. The command range is capped at 0.1 - 120 to avoid performance problems.
  
 +
|s1= [[setTimeMultiplier]] value
  
|x1= <code>[[setTimeMultiplier]] 60;</code> |= Example 1
+
|p1= value: [[Number]] - has to be in range from 0.1 to 120
|x2= <code>[[setTimeMultiplier]] 0.5;</code> |= Example 2
 
  
____________________________________________________________________________________________
+
|r1= [[Nothing]]
  
|[[timeMultiplier]], [[skipTime]], [[setAccTime]], [[accTime]], [[time]], [[serverTime]], [[date]], [[daytime]]  |= SEEALSO
+
|x1= <sqf>setTimeMultiplier 60;</sqf>
  
|mp= Server-side only in multi-player and it works in single-player as well.|= MPBEHAVIOUR
+
|x2= <sqf>setTimeMultiplier 0.5;</sqf>
____________________________________________________________________________________________
+
 
 +
|seealso= [[timeMultiplier]] [[skipTime]] [[setAccTime]] [[accTime]] [[time]] [[serverTime]] [[date]] [[dayTime]]
 
}}
 
}}
 
<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:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Multiplayer|{{uc:{{PAGENAME}}}}]]
 
 
<!-- CONTINUE Notes -->
 
<dl class="command_description">
 
<dd class="notedate">Posted on September 23, 2014 - 02:54 (UTC)</dd>
 
<dt class="note">[[User:Benargee|Benargee]]</dt>
 
<dd class="note">
 
Setting this value too high will cause performance issues. (A3 1.28)
 
</dd>
 
</dl>
 
<!-- DISCONTINUE Notes -->
 
 
<!-- CONTINUE Notes -->
 
<dl class="command_description">
 
<dd class="notedate">Posted on October 26, 2014 - 05:01 (UTC)</dd>
 
<dt class="note">[[User:POLPOX|POLPOX]]</dt>
 
<dd class="note">
 
<code>setTimeMultiplier 0;</code> will crash the game.<br/>
 
setTimeMultiplier will works well at another mission.<br/>
 
setTimeMultiplier < 0 will freeze the game for a short time at 30 minutes interval.<br/>
 
(A3 1.32)
 
</dd>
 
</dl>
 
<!-- DISCONTINUE Notes -->
 

Revision as of 11:24, 13 May 2022

Hover & click on the images for description

Description

Description:
Sets a time multiplier for in-game time. The command range is capped at 0.1 - 120 to avoid performance problems.
Groups:
TimeMission InformationEnvironment

Syntax

Syntax:
setTimeMultiplier value
Parameters:
value: Number - has to be in range from 0.1 to 120
Return Value:
Nothing

Examples

Example 1:
Example 2:

Additional Information

See also:
timeMultiplier skipTime setAccTime accTime time serverTime date dayTime

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