Difference between revisions of "love.timer.getTime"

m (Added newin template)
m
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
{{newin|[[0.3.2]]|032|type=function}}
 
{{newin|[[0.3.2]]|032|type=function}}
Returns the value of a timer with an unspecified starting time.
+
Returns the value of a precise timer with an unspecified starting time.
This function should only be used to calculate differences between points in time, as the starting time of the timer is unknown.
+
 
 +
This function should only be used to calculate differences between points in time, as the starting time of the timer is unknown prior to version [[11.4]]. Beginning with 11.4, the timer is initialized to 0 when the [[love.timer]] module is first loaded (usually before main.lua is loaded).
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 30: Line 31:
 
* [[parent::love.timer]]
 
* [[parent::love.timer]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Returns the amount of time since some time in the past.}}
+
{{#set:Description=Returns the precise amount of time since some time in the past.}}
 
{{#set:Since=000}}
 
{{#set:Since=000}}
 
{{#set:PrettySince=0.3.2}}
 
{{#set:PrettySince=0.3.2}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|love.timer.getTime}}
 
{{i18n|love.timer.getTime}}

Latest revision as of 17:55, 30 December 2021

Available since LÖVE 0.3.2
This function is not supported in earlier versions.

Returns the value of a precise timer with an unspecified starting time.

This function should only be used to calculate differences between points in time, as the starting time of the timer is unknown prior to version 11.4. Beginning with 11.4, the timer is initialized to 0 when the love.timer module is first loaded (usually before main.lua is loaded).

Function

Synopsis

time = love.timer.getTime( )

Arguments

None.

Returns

number time
The time in seconds. Given as a decimal, accurate to the microsecond.

Examples

Checking how long something takes

local start = love.timer.getTime()

-- Concatenate "bar" 1000 times.
local foo = ""
for _ = 1, 1000 do
	foo = foo .. "bar"
end

-- Resulting time difference in seconds. Multiplying it by 1000 gives us the value in milliseconds.
local result = love.timer.getTime() - start
print( string.format( "It took %.3f milliseconds to concatenate 'bar' 1000 times!", result * 1000 ))

See Also


Other Languages