setRain: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "|Game version=" to "|Game version= |gr1= Environment |GROUP1= ")
(32 intermediate revisions by 14 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|S]]
{{Command|Comments=
[[Category:Scripting Commands OFP 1.97|S]]
____________________________________________________________________________________________
[[Category:Scripting Commands ArmA|S]]


back to [[Scripting_Reference#S|COMREF]]
| ofpr |Game name=


<h2 style="color:#000066">'''''time'' setRain ''rain'''''</h2>
|1.75|Game version=


|gr1= Environment |GROUP1=


'''Operand types:'''


'''time:''' [[Number]]


'''rain:''' [[Number]]
|eff= global |Multiplayer Effects=


'''Type of returned value:'''
|serverExec= server |Exec=
____________________________________________________________________________________________


[[Nothing]]
| 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.


'''Compatibility:'''
{{Feature arma3 | Since {{arma3}} this command is MP synchronised:
* If executed on server, the changes will propagate globally.
* If executed on client, the effect is temporary and will soon change to the server setting.
Minimum [[overcast]] needed for rain in {{arma3}} is '''0.5'''.}}|DESCRIPTION=
____________________________________________________________________________________________


Added in version '''1.75'''
| time [[setRain]] rain |SYNTAX=


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


Set '''rain''' density smoothly during given '''time''' (in seconds).<br>
|p2= rain: [[Number]] - new rain value in range 0...1 |PARAMETER2=
Zero time means immediate change.<br>
Rain zero is no rain, rain 1 is maximum rain.<br>
Rain is not possible when overcast is smaller than 0.7.


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


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


60 '''setRain''' 1
| [[overcast]], [[setOvercast]], [[rain]], [[nextWeatherChange]], [[forceWeatherChange]], [[setFog]]  |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|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[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:_Environment|{{uc:{{PAGENAME}}}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on December 15, 2015 - 14:31 (UTC)</dd>
<dt class="note">[[User:Zapat|Zapat]]</dt>
<dd class="note">
[[setTimeMultiplier]] does NOT affect transition time.
</dd>
</dl>
<!-- DISCONTINUE Notes -->
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on November 16, 2016 - 22:06 (UTC)</dd>
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note">
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: <code>[[skipTime]] 1; [[skipTime]] -1;</code>
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 17:19, 18 September 2020

ofpr version.gif1.75
GEGlobalSEServer
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. Template:Feature arma3
Multiplayer:
Pre-Arma 3, each client and the server could have different rain values.
Groups:
Environment

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=159110"