Difference between revisions of "love.event.quit"

m (Removed mention of love.event.push('q') (not used in 0.8.0))
m
 
(14 intermediate revisions by 9 users not shown)
Line 1: Line 1:
 
{{newin|[[0.8.0]]|080|type=function}}
 
{{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.
 +
 
 +
Equivalent to <code>love.event.push("quit", exitstatus)</code>
  
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
−
love.event.quit( )
+
love.event.quit( exitstatus )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
−
None.
+
{{New_feature|0.10.0|
 +
{{param|number|exitstatus (0)|The program exit status to use when closing the application.}} }}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
−
=== Example ===
+
=== Notes ===
 +
On iOS, programmatically exiting the app (this includes call to <code>os.exit</code>) [https://developer.apple.com/library/archive/qa/qa1561/_index.html is not recommended] and may result your app being rejected from App Store. Thus, calling this variant will actually perform restart (see below).
 +
 
 +
== 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">
 
<source lang="lua">
 
function love.keypressed(k)
 
function love.keypressed(k)
Line 21: Line 41:
 
== See Also ==
 
== See Also ==
 
* [[parent::love.event]]
 
* [[parent::love.event]]
 +
* [[love.quit]]
 
[[Category:Functions]]
 
[[Category:Functions]]
−
{{#set:Description=Exits the LÖVE program.}}
+
{{#set:Description=Exits or restarts the LÖVE program.}}
 
{{#set:Since=080}}
 
{{#set:Since=080}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|love.event.quit}}
 
{{i18n|love.event.quit}}

Latest revision as of 03:41, 11 July 2023

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.

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

Function

Synopsis

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.

Notes

On iOS, programmatically exiting the app (this includes call to os.exit) is not recommended and may result your app being rejected from App Store. Thus, calling this variant will actually perform restart (see below).

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

Dansk – Deutsch – English – Español – Français – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Polski – Português – Română – Slovenský – Suomi – Svenska – Türkçe – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – ไทย – 日本語 – 正體中文 – 简体中文 – Tiếng Việt – 한국어
More info

Retrieved from "https://love2d.org./w/index.php?title=love.event.quit&oldid=28587"