BIS fnc setDate: Difference between revisions

Latest revision as of 16:53, 21 May 2023

1.00

Hover & click on the images for description

Description

Description:: Instantly set date and share it across network with optional transition effect.
Execution:: call
Groups:: Environment

Syntax

Syntax:

[value, global, transition] call BIS_fnc_setDate

Parameters:

value: Number or Array in format Date

Number - hours to skip. To show exactly 30 minutes later put 30 / 60; 0.5 will show 29 minutes later
Array in format Date - date

global: Boolean - (Optional, default true) true for global execution

transition: Boolean (Optional, default false) true to show a transition effect instead of an immediate skip

Return Value:

Date - the new date

Examples

Example 1:: [[2035, 12, 31, 23, 59], true, true] call BIS_fnc_setDate;
Example 2:: [4, true, true] call BIS_fnc_setDate; // skip 4 hours. Same as image in description
Example 3:: [30 / 60, true, true] call BIS_fnc_setDate; // skip 30 minutes and show a "30 minutes later" message

Additional Information

See also:: date setDate skipTime

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Environment
-|1.00|= Game version
+|descr= Instantly set date and share it across network with optional transition effect. [[File:BIS_fnc_setDate.jpg|right|300px]]
-____________________________________________________________________________________________
-| <pre>/*
+|s1= [value, global, transition] call [[BIS_fnc_setDate]]
-	Description:
+|p1= value: [[Number]] or [[Array]] in format [[Date]]
-	Instantly set date and share it across network.
+* [[Number]] - hours to skip. To show exactly ''30 minutes later'' put <sqf inline>30 / 60</sqf>; <sqf inline>0.5</sqf> will show {{hl|29 minutes later}}
+* [[Array]] in format [[Date]] - date
-	Parameter(s):
+|p2= global: [[Boolean]] - (Optional, default [[true]]) [[true]] for global execution
-:
-			ARRAY - date in format [Y,M,D,H,M]
-			NUMBER - hours to skip
-: BOOL - true for global execution (default: true)
-(Optional): BOOL - true to show a transition effect instead of immediate skip (default: false)
-	Returns:
-	ARRAY
-*/
-#define VALUEVAR	"bis_fnc_setdate_value"
+|p3= transition: [[Boolean]] (Optional, default [[false]]) [[true]] to show a transition effect instead of an immediate skip
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|r1= [[Date]] - the new date
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_setDate]]; --> |= Syntax
+|x1= <sqf>[[2035, 12, 31, 23, 59], true, true] call BIS_fnc_setDate;</sqf>
-|p1= |= Parameter 1
+|x2= <sqf>[4, true, true] call BIS_fnc_setDate; // skip 4 hours. Same as image in description</sqf>
-| |= Return value
+|x3= <sqf>[30 / 60, true, true] call BIS_fnc_setDate; // skip 30 minutes and show a "30 minutes later" message</sqf>
-____________________________________________________________________________________________
-|x1= <code></code> |=
-____________________________________________________________________________________________
-| |= See also
+|seealso= [[date]] [[setDate]] [[skipTime]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Environment|{{uc:setDate}}]]
-[[Category:Functions|{{uc:setDate}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:setDate}}]]