Difference between revisions of "love.audio.setPosition"

(Added a lot more information on the parameters.)
Line 1: Line 1:
Sets the position of the listener.
+
Sets the position of the listener, which determines how sounds play.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
love.audio.setPosition( v )
+
love.audio.setPosition( x, y, z )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|floatArray|v|A float array of size 3 containing [x,y,z] in that order}}
+
{{param|number|x|The x position of the listener. This sets where sound occurs on the user's speakers. If you want to select either speaker, a value of 1 to -1 will do. If the value is 1 it will play on the left, if 0 the sound will be centered, if -1, the sound will play on the right. If it is over or under these values, the sound will get softer.}}
 +
{{param|number|y|The y position of the listener. This has control over how loud the sound is. If the number is over or under 1 or -1, then the sound will get softer.}}
 +
{{param|number|z|The z position of the listener. Think of this as how far away a sound is. This also has control over how loud the sound is. If the number is over or under 1 or -1, then the sound will get softer.}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.

Revision as of 21:00, 19 January 2011

Sets the position of the listener, which determines how sounds play.

Function

Synopsis

love.audio.setPosition( x, y, z )

Arguments

number x
The x position of the listener. This sets where sound occurs on the user's speakers. If you want to select either speaker, a value of 1 to -1 will do. If the value is 1 it will play on the left, if 0 the sound will be centered, if -1, the sound will play on the right. If it is over or under these values, the sound will get softer.
number y
The y position of the listener. This has control over how loud the sound is. If the number is over or under 1 or -1, then the sound will get softer.
number z
The z position of the listener. Think of this as how far away a sound is. This also has control over how loud the sound is. If the number is over or under 1 or -1, then the sound will get softer.

Returns

Nothing.

See Also

Other Languages