BIS fnc sunriseSunsetTime: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{cc|// " to "{{cc|")
m (Some wiki formatting)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma3
|game1= arma3
 
|version1= 1.58
|1.58


|gr1= Environment
|gr1= Environment


| Calculate sunrise and sunset time.
|descr= Calculate sunrise and sunset time.


| [year,month,day,hour,minute] call [[BIS_fnc_sunriseSunsetTime]];
|s1= date call [[BIS_fnc_sunriseSunsetTime]]


|p1= [[Array]]  - date in format [year,month,day,hour,minute], i.e., standard game date format
|p1= date: [[Array]]  - date in format [[Date]]


| [[Array]] in format [<sunriseTime:number>,<sunsetTime:number>]. Returns special values when the world position is behind the polar cicle: [0,-1] - polar summer (i.e., no sunset), [-1,0] - polar winter (i.e., no sunrise).
|r1= [[Array]] of [[Number]] - [sunriseTime, sunsetTime]. Returns special values when the world position is behind the polar cicle: [0,-1] - polar summer (i.e., no sunset), [-1,0] - polar winter (i.e., no sunrise).


|x1= <code>_sunriseSunsetTime = [[date]] [[call]] [[BIS_fnc_sunriseSunsetTime]]; {{cc|get sunrise/sunset time for the current date}}</code>
|x1= <code>_sunriseSunsetTime = [[date]] [[call]] [[BIS_fnc_sunriseSunsetTime]]; {{cc|get sunrise/sunset time for the current date}}</code>
Line 19: Line 18:
|seealso= [[sunOrMoon]]
|seealso= [[sunOrMoon]]
}}
}}
[[Category:{{Name|arma3}}: Functions|{{uc:sunriseSunsetTime}}]]

Revision as of 09:12, 4 May 2021

Hover & click on the images for description

Description

Description:
Calculate sunrise and sunset time.
Execution:
call
Groups:
Environment

Syntax

Syntax:
date call BIS_fnc_sunriseSunsetTime
Parameters:
date: Array - date in format Date
Return Value:
Array of Number - [sunriseTime, sunsetTime]. Returns special values when the world position is behind the polar cicle: [0,-1] - polar summer (i.e., no sunset), [-1,0] - polar winter (i.e., no sunrise).

Examples

Example 1:
_sunriseSunsetTime = date call BIS_fnc_sunriseSunsetTime; // get sunrise/sunset time for the current date

Additional Information

See also:
sunOrMoon

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