WoW:API SecondsToTime: Difference between revisions

Revision as of 14:23, 5 September 2006

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < SecondsToTime

This function is implemented in Lua here FrameXML/UIParent.lua.

timePassed = SecondsToTime(seconds[, noSeconds]);

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.

@@ Line 1: / Line 1: @@
-  <center>'''SecondsToTime''' ''-Documentation by [[User:Thorarin|Thorarin]]-''</center>
+{{framexmlfunc|FrameXML/UIParent.lua}} __NOTOC__
+  timePassed = SecondsToTime(seconds[, noSeconds]);
 Converts a number of seconds into a localized, user readable timespan.
- timePassed = SecondsToTime(seconds[, noSeconds]);
-----
+== Parameters ==
-;''Arguments''
+=== Arguments ===
+: seconds, noSeconds
+:;seconds : Number - The number of seconds to be represented.
-: Number seconds, Boolean noSeconds
+:;noSeconds : [[Boolean]] (optional) - If ''true'', seconds are omitted from the output. (Omitting it == ''false'')
-:;seconds : The number of seconds to be represented.
+=== Returns ===
-:;noSeconds : Unless ''false'' or ''nil'', seconds are omitted from the output. ''Note that omission of the parameter is effectively the same as setting it to nil.''
+:;timePassed : String - Formatted, localized string representing the specified number of seconds.
-----
-;''Returns''
-:;timePassed : Formatted, localized string representing the specified number of seconds.
+== Example ==
-----
-;''Example''
   local timePassed = SecondsToTime(5461)
   DEFAULT_CHAT_FRAME:AddMessage("5461 seconds is approximately " .. timePassed)
-;''Result''
+=== Result ===
 seconds is approximately 1 Hr 31 Mins
-----
-;''Description''
-: 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 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.
+== Details ==
-: This is not a &quot;core&quot; function. It is defined in <tt>FrameXML\UIParent.lua</tt>.
+: 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.
-{{Template:WoW API}}

Navigation menu

Search