\n \n | Playing | \n The source is currently playing. It can be stopped, paused, or rewound. | \n
\n \n | Paused | \n The source is paused. It can be stopped, played/resumed, or rewound. | \n
\n \n | Stopped | \n The source has been stopped. It can be played. | \n
",
key = "Source",
module = "lovr.audio",
methods = {
{
name = "getBitDepth",
summary = "Get the bit depth of the Source.",
description = "Returns the number of bits per sample in the Source. This is a rough indicator of the resolution of the Source, and is usually 16.",
key = "Source:getBitDepth",
module = "lovr.audio",
variants = {
{
arguments = {},
returns = {
{
name = "bits",
type = "number",
description = "The number of bits per sample."
}
}
}
}
},
{
name = "getChannels",
summary = "Get the number of channels in the Source.",
description = "Returns the number of channels in the Source. Mono sounds have 1 channel and stereo sounds have 2 channels.",
key = "Source:getChannels",
module = "lovr.audio",
variants = {
{
arguments = {},
returns = {
{
name = "channels",
type = "number",
description = "The number of channels."
}
}
}
}
},
{
name = "getCone",
summary = "Get the Source's volume cone.",
description = "Returns the directional volume cone of the Source. The cone is specified by three values: `innerAngle`, `outerAngle`, and `outerVolume`. If the listener is inside the `innerAngle`, the Source won't have its volume changed. Otherwise, the volume will start to decrease, reaching a minimum volume of `outerVolume` once the listener is `outerAngle` degrees from the direction of the Source.",
key = "Source:getCone",
module = "lovr.audio",
notes = "The default `innerAngle` for a Source is `0`.\n\nThe default `outerAngle` for a Source is `2 * math.pi`.\n\nThe default `outerVolume` for a Source is `0`.\n\nMake sure to set the direction of a Source before setting its cone.",
variants = {
{
arguments = {},
returns = {
{
name = "innerAngle",
type = "number",
description = "The inner cone angle, in radians."
},
{
name = "outerAngle",
type = "number",
description = "The outer cone angle, in radians."
},
{
name = "outerVolume",
type = "number",
description = "The outer cone angle, in radians."
}
}
}
}
},
{
name = "getDirection",
summary = "Get the direction vector of the Source.",
description = "Returns the direction vector of the Source (the direction it's playing in).",
key = "Source:getDirection",
module = "lovr.audio",
variants = {
{
arguments = {},
returns = {
{
name = "x",
type = "number",
description = "The x component of the direction vector."
},
{
name = "y",
type = "number",
description = "The y component of the direction vector."
},
{
name = "z",
type = "number",
description = "The z component of the direction vector."
}
}
}
}
},
{
name = "getDuration",
summary = "Get the duration of the Source.",
description = "Returns the duration of the Source.",
key = "Source:getDuration",
module = "lovr.audio",
variants = {
{
arguments = {
{
name = "unit",
type = "TimeUnit",
description = "The unit to return.",
default = "'seconds'"
}
},
returns = {
{
name = "duration",
type = "number",
description = "The duration of the Source."
}
}
}
}
},
{
name = "getFalloff",
summary = "Get the falloff parameters for the Source.",
description = "Returns parameters that control how the volume of the Source falls of with distance.",
key = "Source:getFalloff",
module = "lovr.audio",
related = {
"Source:getVolumeLimits",
"Source:setVolumeLimits"
},
variants = {
{
arguments = {},
returns = {
{
name = "reference",
type = "number",
description = "The distance at which the volume will start to decrease."
},
{
name = "max",
type = "number",
description = "The distance at which the Source will be its quietest."
},
{
name = "rolloff",
type = "number",
description = "How quickly the sound falls off between the reference and max distances (1.0 is the default)."
}
}
}
}
},
{
name = "getPitch",
summary = "Get the pitch of the Source.",
description = "Returns the current pitch factor of the Source. The default is 1.0.",
key = "Source:getPitch",
module = "lovr.audio",
variants = {
{
arguments = {},
returns = {
{
name = "pitch",
type = "number",
description = "The current pitch."
}
}
}
}
},
{
name = "getPosition",
summary = "Get the position of the Source.",
description = "Returns the position of the Source, in meters. Setting the position will cause the Source to be distorted and attenuated based on its position relative to the listener.",
key = "Source:getPosition",
module = "lovr.audio",
variants = {
{
arguments = {},
returns = {
{
name = "x",
type = "number",
description = "The x coordinate."
},
{
name = "y",
type = "number",
description = "The y coordinate."
},
{
name = "z",
type = "number",
description = "The z coordinate."
}
}
}
}
},
{
name = "getSampleRate",
summary = "Get the sample rate of the Source.",
description = "Returns the number of samples per second in the Source. This is usually a high number like 44100.",
key = "Source:getSampleRate",
module = "lovr.audio",
variants = {
{
arguments = {},
returns = {
{
name = "frequency",
type = "number",
description = "The number of samples per second in the Source."
}
}
}
}
},
{
name = "getVelocity",
summary = "Get the velocity of the Source.",
description = "Returns the velocity of the Source, in meters per second. This affects the doppler effect.",
key = "Source:getVelocity",
module = "lovr.audio",
notes = "The Source does not move based on its velocity.",
variants = {
{
arguments = {},
returns = {
{
name = "x",
type = "number",
description = "The x velocity."
},
{
name = "y",
type = "number",
description = "The y velocity."
},
{
name = "z",
type = "number",
description = "The z velocity."
}
}
}
}
},
{
name = "getVolume",
summary = "Get the volume of the Source.",
description = "Returns the current volume factor for the Source. 1.0 is the default and the maximum.",
key = "Source:getVolume",
module = "lovr.audio",
variants = {
{
arguments = {},
returns = {
{
name = "volume",
type = "number",
description = "The volume of the Source."
}
}
}
}
},
{
name = "getVolumeLimits",
summary = "Get the volume limits of the Source.",
description = "Returns the minimum and maximum volume of the Source. These limits have priority over the parameters set by `Source:setFalloff` and `Source:setCone`, so they can be used to make sure a Source can always be heard even if it's far away.",
key = "Source:getVolumeLimits",
module = "lovr.audio",
variants = {
{
arguments = {},
returns = {
{
name = "min",
type = "number",
description = "The minimum volume of the Source."
},
{
name = "max",
type = "number",
description = "The maximum volume of the Source."
}
}
}
}
},
{
name = "isLooping",
summary = "Check if the Source is looping.",
description = "Returns whether or not the Source will loop when it finishes.",
key = "Source:isLooping",
module = "lovr.audio",
variants = {
{
arguments = {},
returns = {
{
name = "looping",
type = "boolean",
description = "Whether or not the Source is looping."
}
}
}
}
},
{
name = "isPaused",
summary = "Check if the Source is paused.",
description = "Returns whether or not the Source is paused.",
key = "Source:isPaused",
module = "lovr.audio",
variants = {
{
arguments = {},
returns = {
{
name = "paused",
type = "boolean",
description = "Whether the Source is paused."
}
}
}
}
},
{
name = "isPlaying",
summary = "Check if the Source is playing.",
description = "Returns whether or not the Source is playing.",
key = "Source:isPlaying",
module = "lovr.audio",
variants = {
{
arguments = {},
returns = {
{
name = "playing",
type = "boolean",
description = "Whether the Source is playing."
}
}
}
}
},
{
name = "isRelative",
summary = "Check if the Source is relative to the listener.",
description = "Returns whether or not the Source is relative to the listener. If a Source is relative then its position, velocity, cone, and direction are all relative to the audio listener.",
key = "Source:isRelative",
module = "lovr.audio",
variants = {
{
arguments = {},
returns = {
{
name = "relative",
type = "boolean",
description = "Whether or not the Source is relative."
}
}
}
}
},
{
name = "isStopped",
summary = "Check if the Source is stopped.",
description = "Returns whether or not the Source is stopped.",
key = "Source:isStopped",
module = "lovr.audio",
variants = {
{
arguments = {},
returns = {
{
name = "stopped",
type = "boolean",
description = "Whether the Source is stopped."
}
}
}
}
},
{
name = "pause",
summary = "Pause the Source.",
description = "Pauses the source. It can be resumed with `Source:resume` or `Source:play`. If a paused source is rewound, it will remain paused.",
key = "Source:pause",
module = "lovr.audio",
variants = {
{
arguments = {},
returns = {}
}
}
},
{
name = "play",
summary = "Play the Source.",
description = "Plays the Source. This has no effect if the Source is already playing.",
key = "Source:play",
module = "lovr.audio",
variants = {
{
arguments = {},
returns = {}
}
}
},
{
name = "resume",
summary = "Resume the Source.",
description = "Resumes the Source.",
key = "Source:resume",
module = "lovr.audio",
variants = {
{
arguments = {},
returns = {}
}
}
},
{
name = "rewind",
summary = "Rewind the Source.",
description = "Rewinds the Source, starting it over at the beginning. Paused Sources will remain paused.",
key = "Source:rewind",
module = "lovr.audio",
variants = {
{
arguments = {},
returns = {}
}
}
},
{
name = "seek",
summary = "Set the playback position of the Source.",
description = "Seeks the Source to the specified position.",
key = "Source:seek",
module = "lovr.audio",
variants = {
{
arguments = {
{
name = "position",
type = "number",
description = "The position to seek to."
},
{
name = "unit",
type = "TimeUnit",
description = "The units for the seek position.",
default = "'seconds'"
}
},
returns = {}
}
}
},
{
name = "setCone",
summary = "Set the Source's volume cone.",
description = "Sets the directional volume cone of the Source. The cone is specified by three values: `innerAngle`, `outerAngle`, and `outerVolume`. If the listener is inside the `innerAngle`, the Source won't have its volume changed. Otherwise, the volume will start to decrease, reaching a minimum volume of `outerVolume` once the listener is `outerAngle` degrees from the direction of the Source.",
key = "Source:setCone",
module = "lovr.audio",
notes = "The default `innerAngle` for a Source is `0`.\n\nThe default `outerAngle` for a Source is `2 * math.pi`.\n\nThe default `outerVolume` for a Source is `0`.\n\nMake sure to set the direction of a Source before setting its cone.",
variants = {
{
arguments = {
{
name = "innerAngle",
type = "number",
description = "The inner cone angle, in radians."
},
{
name = "outerAngle",
type = "number",
description = "The outer cone angle, in radians."
},
{
name = "outerVolume",
type = "number",
description = "The outer cone angle, in radians."
}
},
returns = {}
}
}
},
{
name = "setDirection",
summary = "Set the direction vector of the Source.",
description = "Sets the direction vector of the Source (the direction it's playing in).",
key = "Source:setDirection",
module = "lovr.audio",
variants = {
{
arguments = {
{
name = "x",
type = "number",
description = "The x component of the direction vector."
},
{
name = "y",
type = "number",
description = "The y component of the direction vector."
},
{
name = "z",
type = "number",
description = "The z component of the direction vector."
}
},
returns = {}
}
}
},
{
name = "setFalloff",
summary = "Set the falloff parameters for the Source.",
description = "Sets parameters that control how the volume of the Source falls of with distance.",
key = "Source:setFalloff",
module = "lovr.audio",
related = {
"Source:getVolumeLimits",
"Source:setVolumeLimits"
},
variants = {
{
arguments = {
{
name = "reference",
type = "number",
description = "The distance at which the volume will start to decrease."
},
{
name = "max",
type = "number",
description = "The distance at which the Source will be its quietest."
},
{
name = "rolloff",
type = "number",
description = "How quickly the sound falls off between the reference and max distances (1.0 is the default)."
}
},
returns = {}
}
}
},
{
name = "setLooping",
summary = "Set whether or not the Source loops.",
description = "Sets whether or not the Source loops.",
key = "Source:setLooping",
module = "lovr.audio",
variants = {
{
arguments = {
{
name = "loop",
type = "boolean",
description = "Whether or not the Source will loop."
}
},
returns = {}
}
}
},
{
name = "setPitch",
summary = "Set the pitch of the Source.",
description = "Sets the pitch of the Source. The default is 1.0.",
key = "Source:setPitch",
module = "lovr.audio",
variants = {
{
arguments = {
{
name = "pitch",
type = "number",
description = "The new pitch."
}
},
returns = {}
}
}
},
{
name = "setPosition",
summary = "Set the position of the Source.",
description = "Sets the position of the Source, in meters. Setting the position will cause the Source to be distorted and attenuated based on its position relative to the listener.\n\nOnly mono sources can be positioned.",
key = "Source:setPosition",
module = "lovr.audio",
variants = {
{
arguments = {
{
name = "x",
type = "number",
description = "The x coordinate."
},
{
name = "y",
type = "number",
description = "The y coordinate."
},
{
name = "z",
type = "number",
description = "The z coordinate."
}
},
returns = {}
}
}
},
{
name = "setRelative",
summary = "Set whether or not the Source is relative.",
description = "Sets whether or not the Source is relative to the listener. If a Source is relative then its position, velocity, cone, and direction are all relative to the audio listener.",
key = "Source:setRelative",
module = "lovr.audio",
variants = {
{
arguments = {
{
name = "relative",
type = "boolean",
description = "Whether or not the Source is relative."
}
},
returns = {}
}
}
},
{
name = "setVelocity",
summary = "Set the velocity of the Source.",
description = "Sets the velocity of the Source, in meters per second. This affects the doppler effect.",
key = "Source:setVelocity",
module = "lovr.audio",
notes = "The Source does not move based on its velocity.",
variants = {
{
arguments = {
{
name = "x",
type = "number",
description = "The x velocity."
},
{
name = "y",
type = "number",
description = "The y velocity."
},
{
name = "z",
type = "number",
description = "The z velocity."
}
},
returns = {}
}
}
},
{
name = "setVolume",
summary = "Set the volume of the Source.",
description = "Sets the current volume factor for the Source. 1.0 is the default and the maximum.",
key = "Source:setVolume",
module = "lovr.audio",
variants = {
{
arguments = {
{
name = "volume",
type = "number",
description = "The new volume."
}
},
returns = {}
}
}
},
{
name = "setVolumeLimits",
summary = "Set the volume limits of the Source.",
description = "Sets the minimum and maximum volume of the Source. These limits have priority over the parameters set by `Source:setFalloff` and `Source:setCone`, so they can be used to make sure a Source can always be heard even if it's far away.",
key = "Source:setVolumeLimits",
module = "lovr.audio",
variants = {
{
arguments = {
{
name = "min",
type = "number",
description = "The minimum volume of the Source."
},
{
name = "max",
type = "number",
description = "The maximum volume of the Source."
}
},
returns = {}
}
}
},
{
name = "stop",
summary = "Stop the Source.",
description = "Stops the source.",
key = "Source:stop",
module = "lovr.audio",
variants = {
{
arguments = {},
returns = {}
}
}
},
{
name = "tell",
summary = "Get the playback position of the Source.",
description = "Returns the current playback position of the Source.",
key = "Source:tell",
module = "lovr.audio",
variants = {
{
arguments = {
{
name = "unit",
type = "TimeUnit",
description = "The unit to return.",
default = "'seconds'"
}
},
returns = {
{
name = "position",
type = "number",
description = "The current playback position."
}
}
}
}
}
},
constructors = {
"lovr.audio.newSource"
}
}
}
},
{
name = "event",
tag = "modules",
summary = "Handles events from the operating system.",
description = "The `lovr.event` module handles events from the operating system.\n\nDue to its low-level nature, it's rare to use `lovr.event` in simple projects.",
key = "lovr.event",
functions = {
{
name = "clear",
summary = "Clear the event queue.",
description = "Clears the event queue, removing any unprocessed events.",
key = "lovr.event.clear",
module = "lovr.event",
variants = {
{
arguments = {},
returns = {}
}
}
},
{
name = "poll",
summary = "Iterate over unprocessed events in the queue.",
description = "This function returns a Lua iterator for all of the unprocessed items in the event queue. Each event consists of a name as a string, followed by event-specific arguments. Typically this function is automatically called for you by `lovr.run`.",
key = "lovr.event.poll",
module = "lovr.event",
variants = {
{
arguments = {},
returns = {
{
name = "iterator",
type = "function",
description = "The iterator function, usable in a for loop.",
arguments = {},
returns = {}
}
}
}
}
},
{
name = "pump",
summary = "Pump new events into the queue for processing.",
description = "Fills the event queue with unprocessed events from the operating system. This function should be called often, otherwise the operating system will consider your application unresponsive. By default, this function is called automatically by `lovr.run`.",
key = "lovr.event.pump",
module = "lovr.event",
related = {
"lovr.event.poll"
},
variants = {
{
arguments = {},
returns = {}
}
}
},
{
name = "push",
summary = "Manually push an event onto the queue.",
description = "Pushes an event onto the event queue. It will be processed the next time `lovr.event.poll` is called. For an event to be processed properly, there needs to be a function in the `lovr.handlers` table with a key that's the same as the event name.",
key = "lovr.event.push",
module = "lovr.event",
related = {
"lovr.event.poll",
"lovr.event.quit"
},
variants = {
{
arguments = {
{
name = "name",
type = "string",
description = "The name of the event."
},
{
name = "...",
type = "*",
description = "The arguments for the event."
}
},
returns = {}
}
}
},
{
name = "quit",
summary = "Quit the application.",
description = "Pushes an event to quit the game. An optional number can be passed to set the exit code for the application. An exit code of zero indicates normal termination, whereas a nonzero exit code indicates that an error occurred.",
key = "lovr.event.quit",
module = "lovr.event",
related = {
"lovr.quit",
"lovr.event.poll"
},
variants = {
{
arguments = {
{
name = "code",
type = "number",
description = "The exit code of the program.",
default = "0"
}
},
returns = {}
}
},
notes = "This function is equivalent to:\n\n lovr.event.push('quit', code)\n\nThe program won't actually exit until the next time `lovr.event.poll` is called."
}
},
examples = {
{
description = "Adding a custom event.",
code = "function lovr.load()\n lovr.handlers['customevent'] = function(a, b, c)\n print('custom event handled with args:', a, b, c)\n end\n\n lovr.event.push('customevent', 1, 2, 3)\nend"
}
},
enums = {},
objects = {},
notes = "You can define your own custom events by adding a function to the `lovr.handlers` table with a key of the name of the event you want to add. Then, push the event using `lovr.event.push`."
},
{
name = "filesystem",
tag = "modules",
summary = "Provides access to the filesystem.",
description = "The `lovr.filesystem` module provides access to the filesystem.",
key = "lovr.filesystem",
enums = {},
notes = "LÖVR programs can only write to a single directory, called the save directory. The location of the save directory is platform-specific:\n\n