Difference between revisions of "love.event.wait"

(love.event uses Variant, and doesn't accept all types)
m (Added further arguments and newin and new feature templates)
Line 1: Line 1:
 +
{{newin|[[0.6.0]]|060|type=function}}
 
Like <code>[[love.event.poll]]()</code>, but blocks until there is an event in the queue.
 
Like <code>[[love.event.poll]]()</code>, but blocks until there is an event in the queue.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
e, a, b, c, d = love.event.wait( )
+
n, a, b, c, d, e, f, ... = love.event.wait( )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
{{param|Event|e|The type of event.}}
+
{{param|Event|n|The name of event.}}
 
{{param|Variant|a|First event argument.}}
 
{{param|Variant|a|First event argument.}}
 
{{param|Variant|b|Second event argument.}}
 
{{param|Variant|b|Second event argument.}}
 
{{param|Variant|c|Third event argument.}}
 
{{param|Variant|c|Third event argument.}}
{{param|Variant|d|Fourth event argument.}}
+
{{New_feature|0.8.0|
 +
{{param|Variant|d|Fourth event argument.}} }}
 +
{{New_feature|0.10.0|
 +
{{param|Variant|e|Fifth event argument.}}
 +
{{param|Variant|f|Sixth event argument.}}
 +
{{param|Variant|...|Further event arguments may follow.}} }}
 
== See Also ==
 
== See Also ==
 
* [[parent::love.event]]
 
* [[parent::love.event]]

Revision as of 07:27, 30 December 2018

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

Like love.event.poll(), but blocks until there is an event in the queue.

Function

Synopsis

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

Arguments

None.

Returns

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


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

See Also


Other Languages