Difference between revisions of "love.event.poll"

 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
Gets an iterator for messages in the event queue.
+
{{newin|[[0.6.0]]|060|type=function}}
 +
Returns an iterator for messages in the event queue.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 8: Line 9:
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
{{param|function|i|Iterator function usable in for loop.}}
+
{{param|function|i|Iterator function usable in a for loop.}}
 
== Examples ==
 
== Examples ==
=== Checking for events ===
+
=== Checking for events in 0.10.0 ===
 
<source lang="lua">
 
<source lang="lua">
for e,a,b,c in love.events.poll() do
+
for n, a, b, c, d, e, f in love.event.poll() do
 +
if n == "quit" then
 +
-- Quit!
 +
end
 +
end
 +
</source>
 +
=== Checking for events in 0.8.0 ===
 +
<source lang="lua">
 +
for e, a, b, c, d in love.event.poll() do
 +
if e == "quit" then
 +
-- Quit!
 +
end
 +
end
 +
</source>
 +
=== Checking for events in 0.7.2 ===
 +
<source lang="lua">
 +
for e, a, b, c in love.event.poll() do
 
if e == "q" then
 
if e == "q" then
 
-- Quit!
 
-- Quit!
Line 22: Line 39:
 
* [[love.event.wait]]
 
* [[love.event.wait]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Gets an iterator for messages in the event queue.}}
+
{{#set:Description=Returns an iterator for messages in the event queue.}}
 
{{#set:Since=000}}
 
{{#set:Since=000}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|love.event.poll}}
 
{{i18n|love.event.poll}}

Latest revision as of 22:33, 17 November 2019

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

Returns an iterator for messages in the event queue.

Function

Synopsis

i = love.event.poll( )

Arguments

None.

Returns

function i
Iterator function usable in a for loop.

Examples

Checking for events in 0.10.0

for n, a, b, c, d, e, f in love.event.poll() do
	if n == "quit" then
		-- Quit!
	end	
end

Checking for events in 0.8.0

for e, a, b, c, d in love.event.poll() do
	if e == "quit" then
		-- Quit!
	end	
end

Checking for events in 0.7.2

for e, a, b, c in love.event.poll() do
	if e == "q" then
		-- Quit!
	end	
end

See Also


Other Languages