WoW API: SecondsToTime

From AddOn Studio
Revision as of 15:04, 19 August 2009 by WoWWiki>Dschiggs
Jump to navigation Jump to search


WoW API < SecondsToTime

"I" iconThis function is implemented in Lua here FrameXML/UIParent.lua.


timePassed = SecondsToTime(seconds[, noSeconds]);
Is defined in UIParent.lua as: function SecondsToTime(seconds, noSeconds, notAbbreviated, maxCount)

Converts a number of seconds into a localized, user readable timespan.


Parameters

Arguments

seconds, noSeconds
seconds
Number - The number of seconds to be represented.
noSeconds
Boolean (optional) - If true, seconds are omitted from the output. (Omitting it == false)

Returns

timePassed
String - Formatted, localized string representing the specified number of seconds.


Example

local timePassed = SecondsToTime(5461)
DEFAULT_CHAT_FRAME:AddMessage("5461 seconds is approximately " .. timePassed)

Result

5461 seconds is approximately 1 Hr 31 Mins


Details

Converts a number of seconds to a user readable timespan. The exact result differs for each client language.
Regardless of the noSeconds parameter, the function never returns more than two different time units of precision. i.e. if seconds is greater than 3600, seconds will be omitted. If it is greater than 86400, minutes will also be omitted.