BIS fnc secondsToString: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Page filling)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Convert seconds to formatted string. |= Description
____________________________________________________________________________________________
Description:
Convert seconds to formatted string.
Parameter(s):
_this select 0: <scalar> time in seconds
_this select 1 (Optional): <string> format
"HH" - Hours
"HH:MM" - Hours:Minutes
"HH:MM:SS" - Hours:Minutes:Seconds (Default)
"HH:MM:SS.MS" - Hours:Minutes:Seconds:Milliseconds
"MM" - Minutes
"MM:SS" - Minutes:Seconds
"MM:SS.MS" - Minutes:Seconds:Milliseconds
"SS.MS" - Seconds:Milliseconds
_this select 2 (Optional): <boolean> return as Array (default: false)
Returns:
String or Array of Strings
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
| [totalSeconds, format, returnArray] call [[BIS_fnc_secondsToString]] |= Syntax
____________________________________________________________________________________________
 
|p1= totalSeconds: [[Number]] - time in seconds (see [[time]]) |= Parameter 1


| <!-- [] call [[BIS_fnc_secondsToString]]; --> |= Syntax
|p2= format: [[String]] - (Optional, default "HH:MM:SS") can be one of:
* "HH"
* "HH:MM"
* "HH:MM:SS"
* "HH:MM:SS.MS"
* "MM"
* "MM:SS"
* "MM:SS.MS"
* "SS.MS"
''HH = Hours, MM = Minutes, SS = Seconds, MS = Milliseconds''
|= Parameter 2


|p1= |= Parameter 1
|p3= returnArray: [[Boolean]] - (Optional, default false) |= Parameter 3


| |= Return value
| [[String]] or [[Array]] of [[String|Strings]] if ''returnArray'' is set to [[true]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>[[hint]] [[format]] ["Hi, it is currently %1.", <nowiki>[</nowiki>[[time]], "HH:MM"] [[call]] [[BIS_fnc_secondsToString]]];</code> |= Example 1
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[time]], [[BIS_fnc_showTime]] |= See also
 
}}
}}



Revision as of 00:57, 27 April 2018

Hover & click on the images for description

Description

Description:
Convert seconds to formatted string.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[totalSeconds, format, returnArray] call BIS_fnc_secondsToString
Parameters:
totalSeconds: Number - time in seconds (see time)
format: String - (Optional, default "HH:MM:SS") can be one of:
  • "HH"
  • "HH:MM"
  • "HH:MM:SS"
  • "HH:MM:SS.MS"
  • "MM"
  • "MM:SS"
  • "MM:SS.MS"
  • "SS.MS"
HH = Hours, MM = Minutes, SS = Seconds, MS = Milliseconds
returnArray: Boolean - (Optional, default false)
Return Value:
String or Array of Strings if returnArray is set to true

Examples

Example 1:
hint format ["Hi, it is currently %1.", [time, "HH:MM"] call BIS_fnc_secondsToString];

Additional Information

See also:
timeBIS_fnc_showTime

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

Bottom Section