simulCloudOcclusion: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "Category:Eden Editor" to "Eden Editor")
 
(40 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Environment


|gr1= Environment |GROUP1=
|descr= Returns clouds occlusion between two given points.
____________________________________________________________________________________________


| Returns clouds occlusion between two given points (0 - no clouds, 1 - full clouds). |DESCRIPTION=
|pr= {{Feature|edeneditor|SimulWeather seems to be disabled in [[:Category:Eden Editor|Eden Editor]] and scenario preview.}}
____________________________________________________________________________________________


| '''simulCloudOcclusion''' [pos1,pos2] |SYNTAX=
|s1= [[simulCloudOcclusion]] [pos1, pos2]


|p1= [pos1,pos2]: [[Array]] |PARAMETER1=
|p1= pos1: [[Position]]
|p2= pos1: [[Position]] |PARAMETER2=
|p3= pos2: [[Position]] |PARAMETER3=
| [[Number]] |RETURNVALUE=


|p2= pos2: [[Position]]


|x1= <code>canSeeSun = ('''simulCloudOcclusion''' == 0)</code>|EXAMPLE1=
|r1=  
* [[Number]] - (0 - no clouds, 1 - full clouds)
* [[Nothing]] - If arguments are incorrect
* [[Boolean]] - Returns [[false]] if simulWeather is disabled


____________________________________________________________________________________________
|x1= <sqf>private _posPlayer = getPos player;
private _posAbovePlayer = +_posPlayer; _posAbovePlayer set [2,200];
simulCloudOcclusion [_posPlayer, _posAbovePlayer];</sqf>


| [[setSimulWeatherLayers]], [[simulCloudDensity]], [[simulInClouds]] |SEEALSO=
|seealso= [[setSimulWeatherLayers]] [[simulCloudDensity]] [[simulInClouds]]
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}


<h3 style='display:none'>Notes</h3>
<dl class="command_description">
<dl class='command_description'>
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on 8 August, 2014 - 12:17
<dt><dt>
<dt class="note">[[User:Waffle SS.|Waffle SS.]]
<dd class="notedate">Posted on 8 August, 2014 - 12:17</dd>
<dd class="note">The '''simulCloudOcclusion''' command is not recognized on dedicated servers, and will produce an error.  If you use this command, it '''cannot''' be anywhere within a script that is run on the dedicated server, or the entire script will halt.  To get around this, you can use: <code>if ![[isDedicated]] then {[] [[execVM]] "simulCloudOcclusionScript.sqf"};</code>
<dt class="note">[[User:Waffle SS.|Waffle SS.]]</dt>
<dd class="note">The '''simulCloudOcclusion''' command is not recognized on dedicated servers, and will produce an error.  If you use this command, it '''cannot''' be anywhere within a script that is run on the dedicated server, or the entire script will halt.  To get around this, you can use:
<sqf>if !isDedicated then {[] execVM "simulCloudOcclusionScript.sqf"};</sqf>


<!-- Note Section END -->
</dl>
</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}}}}]]

Latest revision as of 14:27, 9 July 2023

Hover & click on the images for description

Description

Description:
Returns clouds occlusion between two given points.
Problems:
Eden Editor
SimulWeather seems to be disabled in Eden Editor and scenario preview.
Groups:
Environment

Syntax

Syntax:
simulCloudOcclusion [pos1, pos2]
Parameters:
pos1: Position
pos2: Position
Return Value:
  • Number - (0 - no clouds, 1 - full clouds)
  • Nothing - If arguments are incorrect
  • Boolean - Returns false if simulWeather is disabled

Examples

Example 1:
private _posPlayer = getPos player; private _posAbovePlayer = +_posPlayer; _posAbovePlayer set [2,200]; simulCloudOcclusion [_posPlayer, _posAbovePlayer];

Additional Information

See also:
setSimulWeatherLayers simulCloudDensity simulInClouds

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
Posted on 8 August, 2014 - 12:17
Waffle SS.
The simulCloudOcclusion command is not recognized on dedicated servers, and will produce an error. If you use this command, it cannot be anywhere within a script that is run on the dedicated server, or the entire script will halt. To get around this, you can use:
if !isDedicated then {[] execVM "simulCloudOcclusionScript.sqf"};