love

The root module which contains all the other modules. Clearly the loveliest module of all.

When beginning to write games using LÖVE, the most important parts of the API are the callbacks: love.load to do one-time setup of your game, love.update which is used to manage your game's state frame-to-frame, and love.draw which is used to render the game state onto the screen.

More interactive games will override additional callbacks in order to handle input from the user, and other aspects of a full-featured game.

LÖVE provides default placeholders for these callbacks, which you can override inside your own code, simply by specifying their fully qualified name:

function love.load()
   hamster = love.graphics.newImage("hamster.png")
   x = 50
   y = 50
end
function love.draw()
   love.graphics.draw(hamster, x, y)
end

Modules

love.audio	Provides of audio interface for playback/recording sound.
love.data	Provides functionality for creating and transforming data.	11.0
love.event	Manages events, like keypresses.	0.6.0
love.filesystem	Provides an interface to the user's filesystem.
love.font	Allows you to work with fonts.	0.7.0
love.graphics	Drawing of shapes and images, management of screen geometry.
love.image	Provides an interface to decode encoded image data.
love.joystick	Provides an interface to connected joysticks.	0.5.0
love.keyboard	Provides an interface to the user's keyboard.
love.math	Provides system-independent mathematical functions.	0.9.0
love.mouse	Provides an interface to the user's mouse.
love.physics	Can simulate 2D rigid body physics in a realistic manner.	0.4.0
love.sound	This module is responsible for decoding sound files.
love.system	Provides access to information about the user's system.	0.9.0
love.thread	Allows you to work with threads.	0.7.0
love.timer	Provides high-resolution timing functionality.
love.touch	Provides an interface to touch-screen presses.	0.10.0
love.video	This module is responsible for decoding and streaming video files.	0.10.0
love.window	Provides an interface for the program's window.	0.9.0

Types

Data	The superclass of all data.
Object	The superclass of all LÖVE types.
Variant	The types supported by love.thread and love.event.

Callbacks

Config Files	Game configuration settings.
love.directorydropped	Callback function triggered when a directory is dragged and dropped onto the window.	0.10.0
love.displayrotated	Called when the device display orientation changed.	11.3
love.draw	Callback function used to draw on the screen every frame.
love.errhand	The error handler, used to display error messages.
love.errorhandler	The error handler, used to display error messages.	11.0
love.filedropped	Callback function triggered when a file is dragged and dropped onto the window.	0.10.0
love.focus	Callback function triggered when window receives or loses focus.	0.7.0
love.gamepadaxis	Called when a Joystick's virtual gamepad axis is moved.	0.9.0
love.gamepadpressed	Called when a Joystick's virtual gamepad button is pressed.	0.9.0
love.gamepadreleased	Called when a Joystick's virtual gamepad button is released.	0.9.0
love.joystickadded	Called when a Joystick is connected.	0.9.0
love.joystickaxis	Called when a joystick axis moves.	0.9.0
love.joystickhat	Called when a joystick hat direction changes.	0.9.0
love.joystickpressed	Called when a joystick button is pressed.
love.joystickreleased	Called when a joystick button is released.
love.joystickremoved	Called when a Joystick is disconnected.	0.9.0
love.keypressed	Callback function triggered when a key is pressed.
love.keyreleased	Callback function triggered when a keyboard key is released.
love.load	This function is called exactly once at the beginning of the game.
love.lowmemory	Callback function triggered when the system is running out of memory on mobile devices.	0.10.0
love.mousefocus	Callback function triggered when window receives or loses mouse focus.	0.9.0
love.mousemoved	Callback function triggered when the mouse is moved.	0.9.2
love.mousepressed	Callback function triggered when a mouse button is pressed.
love.mousereleased	Callback function triggered when a mouse button is released.
love.quit	Callback function triggered when the game is closed.	0.7.0
love.resize	Called when the window is resized.	0.9.0
love.run	The main function, containing the main loop. A sensible default is used when left out.
love.textedited	Called when the candidate text for an IME has changed.	0.10.0
love.textinput	Called when text has been entered by the user.	0.9.0
love.threaderror	Callback function triggered when a Thread encounters an error.	0.9.0
love.touchmoved	Callback function triggered when a touch press moves inside the touch screen.	0.10.0
love.touchpressed	Callback function triggered when the touch screen is touched.	0.10.0
love.touchreleased	Callback function triggered when the touch screen stops being touched.	0.10.0
love.update	Callback function used to update the state of the game every frame.
love.visible	Callback function triggered when window is shown or hidden.	0.9.0
love.wheelmoved	Callback function triggered when the mouse wheel is moved.	0.10.0

Other Languages

Dansk – Deutsch – English – Español – Français – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Polski – Português – Română – Slovenský – Suomi – Svenska – Türkçe – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – ไทย – 日本語 – 正體中文 – 简体中文 – Tiếng Việt – 한국어
More info

Testing

Config Files	Game configuration settings.	000
love.directorydropped	Callback function triggered when a directory is dragged and dropped onto the window.	100
love.displayrotated	Called when the device display orientation changed.	113
love.draw	Callback function used to draw on the screen every frame.	000
love.errhand	The error handler, used to display error messages.	000
love.errorhandler	The error handler, used to display error messages.	110
love.filedropped	Callback function triggered when a file is dragged and dropped onto the window.	100
love.focus	Callback function triggered when window receives or loses focus.	070
love.gamepadaxis	Called when a Joystick's virtual gamepad axis is moved.	090
love.gamepadpressed	Called when a Joystick's virtual gamepad button is pressed.	090
love.gamepadreleased	Called when a Joystick's virtual gamepad button is released.	090
love.joystickadded	Called when a Joystick is connected.	090
love.joystickaxis	Called when a joystick axis moves.	090
love.joystickhat	Called when a joystick hat direction changes.	090
love.joystickpressed	Called when a joystick button is pressed.	000
love.joystickreleased	Called when a joystick button is released.	000
love.joystickremoved	Called when a Joystick is disconnected.	090
love.keypressed	Callback function triggered when a key is pressed.	000
love.keyreleased	Callback function triggered when a keyboard key is released.	000
love.load	This function is called exactly once at the beginning of the game.	110 000
love.lowmemory	Callback function triggered when the system is running out of memory on mobile devices.	100
love.mousefocus	Callback function triggered when window receives or loses mouse focus.	090
love.mousemoved	Callback function triggered when the mouse is moved.	092 100
love.mousepressed	Callback function triggered when a mouse button is pressed.	110 000
love.mousereleased	Callback function triggered when a mouse button is released.	110 000
love.quit	Callback function triggered when the game is closed.	070
love.resize	Called when the window is resized.	090
love.run	The main function, containing the main loop. A sensible default is used when left out.	000
love.textedited	Called when the candidate text for an IME has changed.	100
love.textinput	Called when text has been entered by the user.	090
love.threaderror	Callback function triggered when a Thread encounters an error.	090
love.touchmoved	Callback function triggered when a touch press moves inside the touch screen.	100
love.touchpressed	Callback function triggered when the touch screen is touched.	100
love.touchreleased	Callback function triggered when the touch screen stops being touched.	100
love.update	Callback function used to update the state of the game every frame.	000
love.visible	Callback function triggered when window is shown or hidden.	090
love.wheelmoved	Callback function triggered when the mouse wheel is moved.	100

Config Files	Game configuration settings.	000
love.audiodisconnected	Called when the active audio device is disconnected.	120
love.directorydropped	Callback function triggered when a directory is dragged and dropped onto the window.	100
love.displayrotated	Called when the device display orientation changed.	113
love.draw	Callback function used to draw on the screen every frame.	000
love.errhand	The error handler, used to display error messages.	000
love.errorhandler	The error handler, used to display error messages.	110
love.filedropped	Callback function triggered when a file is dragged and dropped onto the window.	100
love.focus	Callback function triggered when window receives or loses focus.	070
love.gamepadaxis	Called when a Joystick's virtual gamepad axis is moved.	090
love.gamepadpressed	Called when a Joystick's virtual gamepad button is pressed.	090
love.gamepadreleased	Called when a Joystick's virtual gamepad button is released.	090
love.joystickadded	Called when a Joystick is connected.	090
love.joystickaxis	Called when a joystick axis moves.	090
love.joystickhat	Called when a joystick hat direction changes.	090
love.joystickpressed	Called when a joystick button is pressed.	000
love.joystickreleased	Called when a joystick button is released.	000
love.joystickremoved	Called when a Joystick is disconnected.	090
love.joysticksensorupdated	Called when a Joystick's sensor is updated with new values.	120
love.keypressed	Callback function triggered when a key is pressed.	000
love.keyreleased	Callback function triggered when a keyboard key is released.	000
love.load	This function is called exactly once at the beginning of the game.	110 000
love.localechanged	Callback function triggered when the user's system locale preferences have changed.	120
love.lowmemory	Callback function triggered when the system is running out of memory on mobile devices.	100
love.mousefocus	Callback function triggered when window receives or loses mouse focus.	090
love.mousemoved	Callback function triggered when the mouse is moved.	092 100
love.mousepressed	Callback function triggered when a mouse button is pressed.	110 000
love.mousereleased	Callback function triggered when a mouse button is released.	110 000
love.quit	Callback function triggered when the game is closed.	070
love.resize	Called when the window is resized.	090
love.run	The main function, containing the main loop. A sensible default is used when left out.	000
love.sensorupdated	Called when the in-device sensor is updated.	120
love.textedited	Called when the candidate text for an IME has changed.	100
love.textinput	Called when text has been entered by the user.	090
love.threaderror	Callback function triggered when a Thread encounters an error.	090
love.touchmoved	Callback function triggered when a touch press moves inside the touch screen.	100
love.touchpressed	Callback function triggered when the touch screen is touched.	100
love.touchreleased	Callback function triggered when the touch screen stops being touched.	100
love.update	Callback function used to update the state of the game every frame.	000
love.visible	Callback function triggered when window is shown or hidden.	090
love.wheelmoved	Callback function triggered when the mouse wheel is moved.	100