love.event.wait

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

Like love.event.poll(), but blocks until there is an event in the queue.

Function

Synopsis

n, a, b, c, d, e, f, ... = love.event.wait( )

Arguments

None.

Returns

Event n (nil)

The name of event, or nil if the event is unrecognized.

Variant a

First event argument.

Variant b

Second event argument.

Variant c

Third event argument.

Variant d Available since 0.8.0

Fourth event argument.

Variant e Available since 0.10.0

Fifth event argument.

Variant f Available since 0.10.0

Sixth event argument.

Variant ... Available since 0.10.0

Further event arguments may follow.

Examples

An example that replace love.event.poll() with this function.

function love.run()
    if love.load then love.load(love.arg.parseGameArguments(arg), arg) end
 
    -- Main loop time.
    return function()
        -- Process events.
        if love.event then
            local name, a,b,c,d,e,f = love.event.wait()
            if name then
                if name == "quit" then
                    if not love.quit or not love.quit() then
                        return a or 0
                    end
                end            
                love.handlers[name](a,b,c,d,e,f)
            end
        end
 
        -- Call update and draw
        if love.update then love.update(0) end
 
        if love.graphics and love.graphics.isActive() then
            love.graphics.origin()
            love.graphics.clear(love.graphics.getBackgroundColor())
 
            if love.draw then love.draw() end
 
            love.graphics.present()
        end
    end
end

See Also

• love.event
• love.event.poll