Difference between revisions of "love.event.push"

(love.event uses Variant, and doesn't accept all types)
m (Fix line break)
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{newin|[[0.6.0]]|060|type=function}}
 
Adds an event to the event queue.
 
Adds an event to the event queue.
 +
 +
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 ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
love.event.push( e, a, b, c, d )
+
love.event.push( n, a, b, c, d, e, f, ... )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|Event|e|The name of the event.}}
+
{{param|Event|n|The name of the event.}}
 
{{param|Variant|a (nil)|First event argument.}}
 
{{param|Variant|a (nil)|First event argument.}}
 
{{param|Variant|b (nil)|Second event argument.}}
 
{{param|Variant|b (nil)|Second event argument.}}
Line 13: Line 16:
 
{{param|Variant|d (nil)|Fourth event argument.}}
 
{{param|Variant|d (nil)|Fourth event argument.}}
 
|080}}
 
|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 a game in 0.8.0 ===
+
{{New_feature|0.8.0|
 
<source lang="lua">
 
<source lang="lua">
 
function love.keypressed(k)
 
function love.keypressed(k)
Line 23: Line 31:
 
end
 
end
 
end
 
end
</source>
+
</source>}}
=== Quitting a game in 0.7.2 ===
+
{{Removed_new_feature|0.6.0|0.7.2|
 
<source lang="lua">
 
<source lang="lua">
 
function love.keypressed(k)
 
function love.keypressed(k)
Line 31: Line 39:
 
end
 
end
 
end
 
end
</source>
+
</source>}}
 
== See Also ==
 
== See Also ==
 
* [[parent::love.event]]
 
* [[parent::love.event]]

Revision as of 09:37, 6 October 2019

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

Adds an event to the event queue.

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