Difference between revisions of "love.event.quit"

(Added new feature template)
m (Explained that love.event.quit is just a shortcut for pushing the quit event)
Line 6: Line 6:
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 +
Equivalent to love.event.push("quit", exitstatus)
 
<source lang="lua">
 
<source lang="lua">
 
love.event.quit( exitstatus )
 
love.event.quit( exitstatus )

Revision as of 15:31, 4 March 2020

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

Adds the quit event to the queue.

The quit event is a signal for the event handler to close LÖVE. It's possible to abort the exit process with the love.quit callback.

Function

Synopsis

Equivalent to love.event.push("quit", exitstatus)

love.event.quit( exitstatus )

Arguments

Available since LÖVE 0.10.0
number exitstatus (0)
The program exit status to use when closing the application.

Returns

Nothing.

Function

Available since LÖVE 0.10.2
This variant is not supported in earlier versions.

Restarts the game without relaunching the executable. This cleanly shuts down the main Lua state instance and creates a brand new one.

Synopsis

love.event.quit( "restart" )

Arguments

string "restart"
Tells the default love.run to exit and restart the game without relaunching the executable.

Returns

Nothing.

Example

function love.keypressed(k)
   if k == 'escape' then
      love.event.quit()
   end
end

See Also


Other Languages