Difference between revisions of "love.timer.sleep"

Line 2: Line 2:
 
Sleeps the program for the specified amount of time.
 
Sleeps the program for the specified amount of time.
 
== Function ==
 
== Function ==
{{oldin|[[0.8.0]]|080|type=behaviour}}
+
{{newin|[[0.8.0]]|080|type=behaviour}}
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
love.timer.sleep( ms )
+
love.timer.sleep( s )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|number|ms|Milliseconds to sleep for.}}
+
{{param|number|s|Seconds to sleep for.}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 
+
== Function ==
{{newin|[[0.8.0]]|080|type=behaviour}}
+
{{oldin|[[0.8.0]]|080|type=behaviour}}
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
love.timer.sleep( s )
+
love.timer.sleep( ms )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|number|s|Seconds to sleep for.}}
+
{{param|number|ms|Milliseconds to sleep for.}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 
 
== Examples ==
 
== Examples ==
 
=== Use sleep to cap FPS at 30 (in 0.7.2 or older) ===
 
=== Use sleep to cap FPS at 30 (in 0.7.2 or older) ===

Revision as of 00:53, 11 October 2012

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

Sleeps the program for the specified amount of time.

Function

Available since LÖVE 0.8.0
This behaviour is not supported in earlier versions.

Synopsis

love.timer.sleep( s )

Arguments

number s
Seconds to sleep for.

Returns

Nothing.

Function

Removed in LÖVE 0.8.0
This behaviour is not supported in that and later versions.

Synopsis

love.timer.sleep( ms )

Arguments

number ms
Milliseconds to sleep for.

Returns

Nothing.

Examples

Use sleep to cap FPS at 30 (in 0.7.2 or older)

function love.update(dt)
   if dt < 1/30 then
      love.timer.sleep(1000 * (1/30 - dt))
   end
end

More sophisticated way to cap FPS (in 0.7.2 or older)

This takes into account the time spent updating and drawing each frame.

function love.load()
   min_dt = 1/30
   next_time = love.timer.getMicroTime()
end

function love.update(dt)
   next_time = next_time + min_dt

   --rest of function here
end

function love.draw()
   --rest of function here

   local cur_time = love.timer.getMicroTime()
   if next_time <= cur_time then
      next_time = cur_time
      return
   end
   love.timer.sleep(1000*(next_time - cur_time))
end

See Also

Other Languages