setFog: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (added arma 3 note template)
(Fix description, parameters and examples)
Line 1: Line 1:
{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| ofp |= Game name
| ofp |Game name=


|1.00|= Game version
|1.00|Game version=


|eff= global|= Effects in MP
|eff= global|Effects in MP=
|exec= server|= Exec
 
|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.<br><br>
| Smoothly change the fog over given time (in seconds). See also [[fogParams]].
{{Feature arma3|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.}}
{{Feature arma3|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=
A little information about how Alt Syntax works. The ''fogValue'' is normal [[fog]] value that could be set independently with original [[setFog]] command. ''fogBase'' is the ASL altitude at which the fog will start. 0 is the sea level. ''fogDecay'' is how defined the fog start is. The more defined, the denser is the fog. 1 (or -1) are the max values. If it is positive the fog will be generated below ''fogBase'' line, if negative, above it. If ''fogDecay'' is small, the fog will transition more smoothly from no fog to full fog, and because of that it will cross ''fogBase'' line by quite a lot, depending on how small is ''fogDecay'' value. Current values of ''fogDecay'' and ''fogBase'' can be retrieved with [[fogParams]] |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| time '''setFog''' fog |= Syntax
| time [[setFog]] fog |Syntax=


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


|p2= fog: [[Number]] - new value in range 1...0|= Parameter 2
|p2= fog: [[Number]] - fog density. Range 0..1 |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
|s2= time [[setFog]] [fogValue, fogDecay, fogBase] &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; (''Since Arma 3'') |Syntax2=


|p21= time: [[Number]] - transition time to the new value|= PARAMETER1
|p21= time: [[Number]] - transition time to the new value |PARAMETER21=


|p22= [fogValue, fogDecay, fogBase]: [[Array]] |= PARAMETER2
|p22= [fogValue, fogDecay, fogBase]: [[Array]] of [[Number]]:
* fogValue: [[Number]] - normal [[fog]] value that represents fog density at ''fogBase'' level. Range 0..1
* fogDecay: [[Number]] - decay of fog density with altitude. Range -1..1
* fogBase: [[Number]] - base altitude ([[Position#PositionASL|ASL]]) of fog (in meters). Range -5000..5000 |PARAMETER22=


|p23= fogValue: [[Number]] - value for fog at base level. Range (0...1)|= PARAMETER3
|r2= [[Nothing]] |RETURNVALUE2=
 
|p24= fogDecay: [[Number]] - decay of fog density with altitude. Range (-1...1) |= PARAMETER4
 
|p25= fogBase: [[Number]] - base altitude of fog (in meters). Range (-5000...5000) |= 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;
|x2= Force no fog: <code>0 [[setFog]] 0;
[[forceWeatherChange]];
{{codecomment|// [[forceWeatherChange]]; // change is immediate}}
999999 [[setFog]] 0;</code> |= Example 2
999999 [[setFog]] 0;</code> |Example 2=


|x3= <code>0 [[setFog]] [1, 0.01, 0];</code>|= EXAMPLE3
|x3= <code>0 [[setFog]] [1, 0.01, 0];</code>|EXAMPLE3=


|x4= Mountain fog, starts from 70m ASL and thickens more the higher you climb: <code>0 [[setFog]] [1, -1, 70];</code>|= EXAMPLE3
|x4= Mountain fog, starts from 70m ASL and thickens more the higher you climb: <code>0 [[setFog]] [1, -1, 70];</code> |EXAMPLE4=
|x5= Valley fog, starts from 60m ASL and thickens more the lower you descend: <code>0 [[setFog]] [1, 1, 60];</code>|= EXAMPLE3
 
|x6= Fooooog on the waaaater: <code>0 [[setFog]] [1, 1, 0];</code>|= EXAMPLE3
|x5= Valley fog, starts from 60m ASL and thickens more the lower you descend: <code>0 [[setFog]] [1, 1, 60];</code> |EXAMPLE5=
 
|x6= Fooooog on the waaaater: <code>0 [[setFog]] [1, 1, 0];</code>|EXAMPLE6=
____________________________________________________________________________________________
____________________________________________________________________________________________
| mp =  Pre-Arma 3, each client and the server could have different fog values |= Multiplayer
|mp=  Pre-Arma 3, each client and the server could have different fog values |Multiplayer=
 
|[[Arma 3 Improved Fog]], [[fog]], [[fogParams]], [[fogForecast]], [[nextWeatherChange]], [[forceWeatherChange]], [[setRain]] |= See also


|[[Arma 3 Improved Fog]], [[fog]], [[fogParams]], [[fogForecast]], [[nextWeatherChange]], [[forceWeatherChange]], [[setRain]] |See also=
}}
}}


Line 62: Line 60:


<dd class="notedate">
<dd class="notedate">
<dt class="note">'''[[User:Ceeeb|Ceeeb]]'''<dd class="note">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|SetRain]] changes are independent and can occur simultaneously to a weather change.
<dt class="note">[[User:Ceeeb|Ceeeb]]
<dd class="note">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|SetRain]] changes are independent and can occur simultaneously to a weather change.
 
<dd class="notedate">Posted on December 15, 2015 - 14:32 (UTC)</dd>
<dt class="note">[[User:Zapat|Zapat]]</dt>
<dd class="note">[[setTimeMultiplier]] DOES affect transition time.</dd>


<!-- Note Section END -->
<!-- Note Section END -->
Line 68: Line 73:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|SETFOG]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|SETFOG]]
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|SETFOG]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|SETFOG]]
[[Category:Command_Group:_Environment|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|SETFOG]]
[[Category:Command_Group:_Environment|SETFOG]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{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:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on December 15, 2015 - 14:32 (UTC)</dd>
<dt class="note">[[User:Zapat|Zapat]]</dt>
<dd class="note">
[[setTimeMultiplier]] DOES affect transition time.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 05:09, 10 January 2019

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

Description

Description:
Smoothly change the fog over given time (in seconds). See also fogParams.
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 - fog density. Range 0..1
Return Value:
Nothing

Alternative Syntax

Syntax:
time setFog [fogValue, fogDecay, fogBase]               (Since Arma 3)
Parameters:
time: Number - transition time to the new value
[fogValue, fogDecay, fogBase]: Array of Number:
  • fogValue: Number - normal fog value that represents fog density at fogBase level. Range 0..1
  • fogDecay: Number - decay of fog density with altitude. Range -1..1
  • fogBase: Number - base altitude (ASL) of fog (in meters). Range -5000..5000
Return Value:
Nothing

Examples

Example 1:
15 setFog 0.5;
Example 2:
Force no fog: 0 setFog 0; // forceWeatherChange; // change is immediate 999999 setFog 0;
Example 3:
0 setFog [1, 0.01, 0];
Example 4:
Mountain fog, starts from 70m ASL and thickens more the higher you climb: 0 setFog [1, -1, 70];
Example 5:
Valley fog, starts from 60m ASL and thickens more the lower you descend: 0 setFog [1, 1, 60];
Example 6:
Fooooog on the waaaater: 0 setFog [1, 1, 0];

Additional Information

See also:
Arma 3 Improved FogfogfogParamsfogForecastnextWeatherChangeforceWeatherChangesetRain

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.
Posted on December 15, 2015 - 14:32 (UTC)
Zapat
setTimeMultiplier DOES affect transition time.

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=setFog&oldid=116118"