@@ -1,4 +1,5 @@
return {
+ tag = 'sourceUtility',
summary = 'Create an identical copy of the Source.',
description = [[
Creates a copy of the Source, referencing the same `Sound` object and inheriting all of the
+ tag = 'sourceEffects',
summary = 'Get the directivity of the Source.',
Returns the directivity settings for the Source.
+ tag = 'sourcePlayback',
summary = 'Get the duration of the Source.',
description = 'Returns the duration of the Source.',
arguments = {
summary = 'Get the orientation of the Source.',
description = 'Returns the orientation of the Source, in angle/axis representation.',
arguments = {},
summary = 'Get the pose of the Source.',
description = 'Returns the position and orientation of the Source.',
summary = 'Get the position of the Source.',
Returns the position of the Source, in meters. Setting the position will cause the Source to
summary = 'Get the radius of the Source.',
Returns the radius of the Source, in meters.
summary = 'Get the volume of the Source.',
description = 'Returns the current volume factor for the Source.',
@@ -14,5 +14,19 @@ return {
constructors = {
'lovr.audio.newSource',
'Source:clone'
+ },
+ sections = {
+ {
+ name = 'Playback',
+ tag = 'sourcePlayback'
+ name = 'Spatial Effects',
+ tag = 'sourceEffects'
+ name = 'Utility',
+ tag = 'sourceUtility'
+ }
}
summary = 'Check if an effect is enabled.',
description = 'Returns whether a given `Effect` is enabled for the Source.',
summary = 'Check if the Source is looping.',
description = 'Returns whether or not the Source will loop when it finishes.',
summary = 'Check if the Source is playing.',
description = 'Returns whether or not the Source is playing.',
summary = 'Pause the Source.',
Pauses the source. It can be resumed with `Source:resume` or `Source:play`. If a paused source
summary = 'Play the Source.',
description = 'Plays the Source. This doesn\'t do anything if the Source is already playing.',
summary = 'Set the playback position of the Source.',
description = 'Seeks the Source to the specified position.',
summary = 'Set the directivity of the Source.',
Sets the directivity settings for the Source.
summary = 'Enable or disable an effect.',
description = 'Enables or disables an effect on the Source.',
summary = 'Set whether or not the Source loops.',
description = 'Sets whether or not the Source loops.',
summary = 'Set the orientation of the Source.',
description = 'Sets the orientation of the Source in angle/axis representation.',
summary = 'Set the pose of the Source.',
description = 'Sets the position and orientation of the Source.',
summary = 'Set the position of the Source.',
Sets the position of the Source, in meters. Setting the position will cause the Source to be
summary = 'Set the radius of the Source.',
Sets the radius of the Source, in meters.
summary = 'Set the volume of the Source.',
description = 'Sets the current volume factor for the Source.',
summary = 'Stop the Source.',
description = 'Stops the source, also rewinding it to the beginning.',
summary = 'Get the playback position of the Source.',
description = 'Returns the current playback position of the Source.',