Difference between revisions of "love.audio.getPosition"

m (1 revision: Imported docs from potato.)
m (Added note about sounds having to be mono for positional audio.)
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
+
Returns the position of the listener. Please note that positional audio only works for mono (i.e. non-stereo) sources.
 
 
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
v = love.audio.getPosition( )
+
x, y, z = love.audio.getPosition( )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
{{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.}}
 +
{{param|number|y|The Y position of the listener.}}
 +
{{param|number|z|The Z position of the listener.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::love.audio]]
 
* [[parent::love.audio]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Returns the position of the listener.}}
 +
{{#set:Since=000}}
 +
== Other Languages ==
 +
{{i18n|love.audio.getPosition}}

Latest revision as of 21:53, 15 August 2014

Returns the position of the listener. Please note that positional audio only works for mono (i.e. non-stereo) sources.

Function

Synopsis

x, y, z = love.audio.getPosition( )

Arguments

None.

Returns

number x
The X position of the listener.
number y
The Y position of the listener.
number z
The Z position of the listener.

See Also


Other Languages