Difference between revisions of "love.audio.play"

(Calling this function does return a boolean value.)
(Consistency edit for this article; singular variant changes updated with corrected variants and their version history.)
Line 1: Line 1:
 +
Plays specific [[Source|Sources]].
 +
 +
== Function ==
 +
{{oldin|[[0.9.1]]|091|type=variant}}
 
Plays the specified Source.
 
Plays the specified Source.
 +
=== Synopsis ===
 +
<source lang="lua">
 +
love.audio.play( source )
 +
</source>
 +
=== Arguments ===
 +
{{param|Source|source|The Source to play.}}
 +
=== Returns ===
 +
Nothing.
  
 
== Function ==
 
== Function ==
 +
{{newinoldin|[[0.9.1]]|091|[[11.0]]|110|type=variant}}
 +
Plays the specified Source.
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 9: Line 23:
 
{{param|Source|source|The Source to play.}}
 
{{param|Source|source|The Source to play.}}
 
=== Returns ===
 
=== Returns ===
{{param|boolean|success|Whether the Source was able to successfully start playing.}}
+
{{param|boolean|success|Whether the Sources were able to successfully start playing.}}
  
 
== Function ==
 
== Function ==
 
{{newin|[[11.0]]|110|type=variant}}
 
{{newin|[[11.0]]|110|type=variant}}
Starts playing multiple Sources simultaneously.
+
Starts playing one or multiple Sources simultaneously.
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
love.audio.play( sources )
+
love.audio.play( source, ... )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|table|sources|Table containing a list of Sources to play.}}
+
{{param|Source|source|The first Source to play.}}
 +
{{param|Source|...|Additional Sources to play.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|boolean|success|Whether the Sources were able to successfully start playing.}}
 
{{param|boolean|success|Whether the Sources were able to successfully start playing.}}
 +
 
== Function ==
 
== Function ==
 
{{newin|[[11.0]]|110|type=variant}}
 
{{newin|[[11.0]]|110|type=variant}}
Starts playing multiple Sources simultaneously.
+
Starts playing one or multiple Sources simultaneously.
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
love.audio.play( source1, source2, ... )
+
love.audio.play( sources )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|Source|source1|The first Source to play.}}
+
{{param|table|sources|Table containing a list of Sources to play.}}
{{param|Source|source2|The second Source to play.}}
 
{{param|Source|...|Additional Sources to play.}}
 
 
=== Returns ===
 
=== Returns ===
 
{{param|boolean|success|Whether the Sources were able to successfully start playing.}}
 
{{param|boolean|success|Whether the Sources were able to successfully start playing.}}
 +
 
== See Also ==
 
== See Also ==
 
* [[parent::love.audio]]
 
* [[parent::love.audio]]

Revision as of 14:57, 13 February 2022

Plays specific Sources.

Function

Removed in LÖVE 0.9.1
This variant is not supported in that and later versions.

Plays the specified Source.

Synopsis

love.audio.play( source )

Arguments

Source source
The Source to play.

Returns

Nothing.

Function

Available since LÖVE 0.9.1 and removed in LÖVE 11.0
This variant is not supported in earlier or later versions.

Plays the specified Source.

Synopsis

love.audio.play( source )

Arguments

Source source
The Source to play.

Returns

boolean success
Whether the Sources were able to successfully start playing.

Function

Available since LÖVE 11.0
This variant is not supported in earlier versions.

Starts playing one or multiple Sources simultaneously.

Synopsis

love.audio.play( source, ... )

Arguments

Source source
The first Source to play.
Source ...
Additional Sources to play.

Returns

boolean success
Whether the Sources were able to successfully start playing.

Function

Available since LÖVE 11.0
This variant is not supported in earlier versions.

Starts playing one or multiple Sources simultaneously.

Synopsis

love.audio.play( sources )

Arguments

table sources
Table containing a list of Sources to play.

Returns

boolean success
Whether the Sources were able to successfully start playing.

See Also


Other Languages