Difference between revisions of "love.event.quit"

Revision as of 07:06, 30 December 2018

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.

love.event.quit( exitstatus )

Available since LÖVE 0.10.0

number exitstatus (0): The program exit status to use when closing the application.

Nothing.

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.

love.event.quit( "restart" )

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

Nothing.

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

@@ Line 1: / Line 1: @@
 {{newin|[[0.8.0]]|080|type=function}}
-Exits the LÖVE program.
+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 ===
 <source lang="lua">
-love.event.quit( )
+love.event.quit( exitstatus )
 </source>
 === Arguments ===
-None.
+{{New_feature|0.10.0|
+{{param|number|exitstatus (0)|The program exit status to use when closing the application.}} }}
 === Returns ===
-Doesn't return.
+Nothing.
-=== Example ===
+== Function ==
+{{newin|[[0.10.2]]|102|type=variant}}
+Restarts the game without relaunching the executable. This cleanly shuts down the main Lua state instance and creates a brand new one.
+=== Synopsis ===
+<source lang="lua">
+love.event.quit( "restart" )
+</source>
+=== Arguments ===
+{{param|string|"restart"|Tells the default [[love.run]] to exit and restart the game without relaunching the executable.}}
+=== Returns ===
+Nothing.
+== Example ==
 <source lang="lua">
 function love.keypressed(k)
@@ Line 21: / Line 37: @@
 == See Also ==
 * [[parent::love.event]]
+* [[love.quit]]
 [[Category:Functions]]
-{{#set:Description=Exits the LÖVE program.}}
+{{#set:Description=Exits or restart the LÖVE program.}}
 {{#set:Since=080}}
 == Other Languages ==
 {{i18n|love.event.quit}}