setRain: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (template:command argument fix)
(One intermediate revision by one other user not shown)
Line 12: Line 12:
| Set rain density smoothly over the given transition time (in seconds). A transition time of zero means an immediate change. A rain density of zero is no rain, one is maximum rain. Rain is not possible when [[overcast]] is less than 0.7.
| Set rain density smoothly over the given transition time (in seconds). A transition time of zero means an immediate change. A rain density of zero is no rain, one is maximum rain. Rain is not possible when [[overcast]] is less than 0.7.
<br><br>
<br><br>
'''NOTE''': Since Arma 3 this command is MP synchronised, if executed on server, the changes will propagate globally. If executed on client effect is temporary as it will soon change to the server setting. |= Description |= Description
'''NOTE''': Since Arma 3 this command is MP synchronised, if executed on server, the changes will propagate globally. If executed on client effect is temporary as it will soon change to the server setting. |DESCRIPTION= |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| time '''setRain''' rain |= Syntax
| time '''setRain''' rain |SYNTAX=


|p1= time: [[Number]] - transition time to the new value in seconds |= Parameter 1
|p1= time: [[Number]] - transition time to the new value in seconds |PARAMETER1=


|p2= rain: [[Number]] - new rain value in range 0...1 |= Parameter 2
|p2= rain: [[Number]] - new rain value in range 0...1 |PARAMETER2=


| [[Nothing]] |= Return value
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>60 [[setRain]] 1;</code> |= Example 1
|x1= <code>60 [[setRain]] 1;</code> |EXAMPLE1=


|x2= Force no rain: <code>0 [[setRain]] 0;
|x2= Force no rain: <code>0 [[setRain]] 0;
[[forceWeatherChange]];
[[forceWeatherChange]];
999999 [[setRain]] 0;</code> |= Example 2
999999 [[setRain]] 0;</code> |EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________
| mp = Pre-Arma 3, each client and the server could have different rain values. |= Multiplayer
| mp = Pre-Arma 3, each client and the server could have different rain values. |= Multiplayer


| [[overcast]], [[setOvercast]], [[rain]], [[nextWeatherChange]], [[forceWeatherChange]], [[setFog]]  |= See also
| [[overcast]], [[setOvercast]], [[rain]], [[nextWeatherChange]], [[forceWeatherChange]], [[setFog]]  |SEEALSO=


}}
}}
Line 59: Line 59:
<dt class="note">[[User:Zapat|Zapat]]</dt>
<dt class="note">[[User:Zapat|Zapat]]</dt>
<dd class="note">
<dd class="note">
[http://community.bistudio.com/wiki/setTimeMultiplier setTimeMultiplier] does NOT affect transition time.
[[setTimeMultiplier]] does NOT affect transition time.
</dd>
</dd>
</dl>
</dl>

Revision as of 15:48, 7 April 2019

ofpr version.gif1.75
GEGlobal
Hover & click on the images for description

Description

Description:
Set rain density smoothly over the given transition time (in seconds). A transition time of zero means an immediate change. A rain density of zero is no rain, one is maximum rain. Rain is not possible when overcast is less than 0.7.

NOTE: Since Arma 3 this command is MP synchronised, if executed on server, the changes will propagate globally. If executed on client effect is temporary as it will soon change to the server setting.
Multiplayer:
Pre-Arma 3, each client and the server could have different rain values.
Groups:
Uncategorised

Syntax

Syntax:
time setRain rain
Parameters:
time: Number - transition time to the new value in seconds
rain: Number - new rain value in range 0...1
Return Value:
Nothing

Examples

Example 1:
60 setRain 1;
Example 2:
Force no rain: 0 setRain 0; forceWeatherChange; 999999 setRain 0;

Additional Information

See also:
overcastsetOvercastrainnextWeatherChangeforceWeatherChangesetFog

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

Posted on December 15, 2015 - 14:31 (UTC)
Zapat
setTimeMultiplier does NOT affect transition time.
Posted on November 16, 2016 - 22:06 (UTC)
Killzone Kid
Using Example 2 on dedicated server might need additional interference on JIP clients. The reason is that JIP has rain value > 0 slowly changing to 0. To force client to sync one can execute this on client: skipTime 1; skipTime -1;
Retrieved from "https://community.bistudio.com/wiki?title=setRain&oldid=122625"