Difference between revisions of "love.event.push"

m (1 revision: Importing from potato (again).)
(Specify what types of arguments are supported for the events)
 
(13 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 +
{{newin|[[0.6.0]]|060|type=function}}
 +
Adds an event to the event queue.
 +
 +
See [[Variant]] for the list of supported types for the arguments.
 +
 +
From [[0.10.0]] onwards, you may pass an arbitrary amount of arguments with this function, though the default callbacks don't ever use more than six.
  
Adds an event to the event queue.
 
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
love.event.push( e, a, b, c )
+
love.event.push( n, a, b, c, d, e, f, ... )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|Event|e|The type of event.}}
+
{{param|Event|n|The name of the event.}}
{{param|mixed|a (nil)|First event argument.}}
+
{{param|Variant|a (nil)|First event argument.}}
{{param|mixed|b (nil)|Second event argument.}}
+
{{param|Variant|b (nil)|Second event argument.}}
{{param|mixed|c (nil)|Third event argument.}}
+
{{param|Variant|c (nil)|Third event argument.}}
 +
{{New_feature|0.8.0|
 +
{{param|Variant|d (nil)|Fourth event argument.}}
 +
|080}}
 +
{{New_feature|0.10.0|
 +
{{param|Variant|e (nil)|Fifth event argument.}}
 +
{{param|Variant|f (nil)|Sixth event argument.}}
 +
{{param|Variant|... (nil)|Further event arguments may follow.}}
 +
|100}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 
== Examples ==
 
== Examples ==
=== Quitting an app ===
+
{{New_feature|0.8.0|
 +
<source lang="lua">
 +
function love.keypressed(k)
 +
if k == 'escape' then
 +
love.event.push('quit') -- Quit the game.
 +
end
 +
end
 +
</source>}}
 +
{{Removed_new_feature|0.6.0|0.7.2|
 
<source lang="lua">
 
<source lang="lua">
 
function love.keypressed(k)
 
function love.keypressed(k)
 
if k == 'escape' then
 
if k == 'escape' then
love.event.push('q') -- quit the game
+
love.event.push('q') -- Quit the game.
 
end
 
end
 
end
 
end
</source>
+
</source>}}
 
== See Also ==
 
== See Also ==
 
* [[parent::love.event]]
 
* [[parent::love.event]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Adds an event to the event queue.}}
 
{{#set:Description=Adds an event to the event queue.}}
 +
{{#set:Since=000}}
 +
== Other Languages ==
 +
{{i18n|love.event.push}}

Latest revision as of 13:17, 17 July 2020

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

Adds an event to the event queue.

See Variant for the list of supported types for the arguments.

From 0.10.0 onwards, you may pass an arbitrary amount of arguments with this function, though the default callbacks don't ever use more than six.

Function

Synopsis

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

Arguments

Event n
The name of the event.
Variant a (nil)
First event argument.
Variant b (nil)
Second event argument.
Variant c (nil)
Third event argument.
Available since LÖVE 0.8.0
Variant d (nil)
Fourth event argument.


Available since LÖVE 0.10.0
Variant e (nil)
Fifth event argument.
Variant f (nil)
Sixth event argument.
Variant ... (nil)
Further event arguments may follow.

Returns

Nothing.

Examples

Available since LÖVE 0.8.0
function love.keypressed(k)
	if k == 'escape' then
		love.event.push('quit') -- Quit the game.
	end	
end


Available since LÖVE 0.6.0 and removed in LÖVE 0.7.2
function love.keypressed(k)
	if k == 'escape' then
		love.event.push('q') -- Quit the game.
	end	
end

See Also


Other Languages