setFog: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
(merged)
Line 6: Line 6:
|1.00|= Game version
|1.00|= Game version


|eff= local|= Effects in MP
|eff= global|= Effects in MP
|exec= server|= Exec
____________________________________________________________________________________________
____________________________________________________________________________________________


| Changes the fog smoothly over the the given TransitionTime (in seconds). A time of zero means there will be an immediate change. A fog intensity of zero is minimum fog and a fog level of one is maximum fog. |= Description
| Changes the fog smoothly over the the given TransitionTime (in seconds). A time of zero means there will be an immediate change. A fog intensity of zero is minimum fog and a fog level of one is maximum fog.<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
____________________________________________________________________________________________
____________________________________________________________________________________________


| time '''setFog''' fog |= Syntax
| time '''setFog''' fog |= Syntax


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


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


| [[Nothing]] |= Return value
| [[Nothing]] |= Return value
| s2= time '''setFog''' [fogValue, fogDecay, fogBase]  &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;(''available since Arma 3 v0.50'') |= Syntax
|p21= time: [[Number]] - transition time to the new value|= PARAMETER1
|p22= [fogValue, fogDecay, fogBase]: [[Array]]  |= PARAMETER2
|p23= fogValue: [[Number]] - value for fog at base level |= PARAMETER3
|p24= fogDecay: [[Number]] - decay of fog density with altitude |= PARAMETER4
|p25= fogBase: [[Number]] - base altitude of fog (in meters) |= PARAMETER5
| r2= [[Nothing]] |= RETURNVALUE
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>15 [[setFog]] 0.5;</code> |= Example 1
|x1= <code>15 [[setFog]] 0.5;</code> |= Example 1
|x2= Force no fog: <code>0 [[setFog]] 0;
[[forceWeatherChange]];
999999 [[setFog]] 0;</code> |= Example 2
|x3= <code>0 '''setFog''' [1, 0.01, 0];</code>|= EXAMPLE3
____________________________________________________________________________________________
____________________________________________________________________________________________
| mp = Each client and the server can have differing fog values (Pre-Arma 3). |= Multiplayer
| mp = Pre-Arma 3, each client and the server could have different fog values |= Multiplayer


| [[setFog array]], [[fog]], [[fogParams]], [[fogForecast]], [[nextWeatherChange]] |= See also
| [[fog]], [[fogParams]], [[fogForecast]], [[nextWeatherChange]], [[forceWeatherChange]], [[setRain]] |= See also


}}
}}
Line 50: Line 73:
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
<!-- CONTINUE Notes -->

Revision as of 15:33, 23 March 2016

Logo A0.png1.00
GEGlobal
Hover & click on the images for description

Description

Description:
Changes the fog smoothly over the the given TransitionTime (in seconds). A time of zero means there will be an immediate change. A fog intensity of zero is minimum fog and a fog level of one is maximum fog.

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 fog values
Groups:
Uncategorised

Syntax

Syntax:
time setFog fog
Parameters:
time: Number - transition time to the new value
fog: Number - new value in range 1...0
Return Value:
Nothing

Alternative Syntax

Syntax:
time setFog [fogValue, fogDecay, fogBase]              (available since Arma 3 v0.50)
Parameters:
time: Number - transition time to the new value
[fogValue, fogDecay, fogBase]: Array
fogValue: Number - value for fog at base level
fogDecay: Number - decay of fog density with altitude
fogBase: Number - base altitude of fog (in meters)
Return Value:
Nothing

Examples

Example 1:
15 setFog 0.5;
Example 2:
Force no fog: 0 setFog 0; forceWeatherChange; 999999 setFog 0;
Example 3:
0 setFog [1, 0.01, 0];

Additional Information

See also:
fogfogParamsfogForecastnextWeatherChangeforceWeatherChangesetRain

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

Ceeeb
Only one script command induced weather change (either setOvercast or setFog) can be happening at a time. Starting a new weather change will immediately halt the current weather change. SetRain changes are independent and can occur simultaneously to a weather change.

Bottom Section

Posted on December 15, 2015 - 14:32 (UTC)
Zapat
setTimeMultiplier DOES affect transition time.
Retrieved from "https://community.bistudio.com/wiki?title=setFog&oldid=94977"