BIS fnc calculateDateTime: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - " |s1=[" to " |s1= [")
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.86


|1.86|Game version=
|gr1= Environment


|gr1 = Environment |GROUP1=
|descr= Returns the end datetime if an offset is passed, or the offset between start and end dates.


| Returns the end datetime if an offset is passed, or the offset between start and end dates. |Description=
|s1= [startDate, endDateOrOffset, timeUnit] call [[BIS_fnc_calculateDateTime]]


| [startDate, endDateOrOffset, timeUnit] call [[BIS_fnc_calculateDateTime]] |Syntax=
|p1= startDate: [[Array]] in [[Date]] format - (Optional, default [[date]])


|p1= startDate: [[Array]] in [[Date]] format - (Optional, default [[date]]) |Parameter 1=
|p2= endDateOrOffset: [[Array]] in [[Date]] format or [[Number]] - (Optional, default [[date]]) either the end date of the period to calculate, or time in seconds from ''startDate''
 
|p2= endDateOrOffset: [[Array]] in [[Date]] format or [[Number]] - (Optional, default [[date]]) either the end date of the period to calculate, or time in seconds from ''startDate'' |Parameter 2=


|p3= timeUnit: [[String]] - (Optional, default "s") one of:
|p3= timeUnit: [[String]] - (Optional, default "s") one of:
Line 21: Line 20:
* "d" - days
* "d" - days


| [[Date]] or [[Number]] - [[Date]] if ''endDateOrOffset'' is a [[Number]], [[Number]] is ''endDateOrOffset'' is a [[Date]] |Return value=
|r1= [[Date]] or [[Number]]
* [[Date]] if ''endDateOrOffset'' is a [[Number]]
* [[Number]] is ''endDateOrOffset'' is a [[Date]]


|x1= <code>[<nowiki/>[[date]], 3600] [[call]] [[BIS_fnc_calculateDateTime]]; {{cc|returns date in 3600 seconds (60min, 1h)}}
|x1= <sqf>
Example: [<nowiki/>[[date]], 60, "m"] [[call]] [[BIS_fnc_calculateDateTime]]; {{cc|returns date in 60 minutes (1h)}}
[date, 3600] call BIS_fnc_calculateDateTime; // returns date in 3600 seconds (60min, 1h)
Example: [<nowiki/>[2035,8,28,11,55], [2035,8,29,11,55], "h"] [[call]] [[BIS_fnc_calculateDateTime]]; {{cc|returns 24}}</code> |Example 1=
[date, 60, "m"] call BIS_fnc_calculateDateTime; // returns date in 60 minutes (1h)
[[2035,8,28,11,55], [2035,8,29,11,55], "h"] call BIS_fnc_calculateDateTime; // returns 24
</sqf>


| [[date]], [[setDate]], [[BIS_fnc_setDate]] |See also=
|seealso= [[date]] [[setDate]] [[BIS_fnc_setDate]]
}}
}}

Latest revision as of 23:11, 12 July 2022

Arma 3 logo black.png1.86
Hover & click on the images for description

Description

Description:
Returns the end datetime if an offset is passed, or the offset between start and end dates.
Execution:
call
Groups:
Environment

Syntax

Syntax:
[startDate, endDateOrOffset, timeUnit] call BIS_fnc_calculateDateTime
Parameters:
startDate: Array in Date format - (Optional, default date)
endDateOrOffset: Array in Date format or Number - (Optional, default date) either the end date of the period to calculate, or time in seconds from startDate
timeUnit: String - (Optional, default "s") one of:
  • "s" - seconds
  • "m" - minutes
  • "h" - hours
  • "d" - days
Return Value:
Date or Number

Examples

Example 1:
[date, 3600] call BIS_fnc_calculateDateTime; // returns date in 3600 seconds (60min, 1h) [date, 60, "m"] call BIS_fnc_calculateDateTime; // returns date in 60 minutes (1h) [[2035,8,28,11,55], [2035,8,29,11,55], "h"] call BIS_fnc_calculateDateTime; // returns 24

Additional Information

See also:
date setDate BIS_fnc_setDate

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_calculateDateTime&oldid=327310"