hazzard993 / love-api

The whole LÖVE wiki in a Lua table.

LÖVE-API

The complete API documentation of LÖVE contained in a Lua table.

The API information is updated manually based on the LÖVE Wiki. Therefore there is no guarantee that everything is correct and up to date. If you find any errors, outdated information or missing content, please file a bug report or create a pull request.

Contributions are more than welcome!

Versions

• The master branch contains the most recent documentation, is constantly updated and follows the official wiki
• You can find the documentation for older versions by checking the releases

Table structure

return {
    version = '11.1',
    functions = { -- love.something functions, currently only love.getVersion
        -- See function structure below
    },
    modules = {
        {
            name = 'modulename',
            description = 'Description.',
            types = {
                -- See type structure below
            },
            functions = {
                -- See function structure below
            },
            enums = {
                {
                    name = 'EnumName',
                    description = 'Description.',
                    constants = {
                        {
                            name = 'constantname',
                            description = 'Description.'
                        }
                    }
                }
            }
        }
    },
    types = { -- Currently only supertypes
        -- See type structure below
    },
    callbacks = {
        -- See function structure below
    }
}

types = {
    {
        name = 'TypeName',
        description = 'Description.',
        constructors = { -- Optional
            'newTypeName'
        },
        functions = { -- Optional
            -- See function structure below
        },
        parenttype = 'Parenttype' --Optional
        supertypes = { -- Optional
            'Supertype'
        },
        subtypes = { -- Optional
            'Subtype'
        }
    }
}

functions = { -- callbacks = {
    {
        name = 'functionName',
        description = 'Description.',
        variants = {
            {
                returns = { -- Optional
                    {
                        type = 'type',
                        name = 'name',
                        description = 'Description.',
                        table = { -- If type is table
                            {
                                type = 'string',
                                name = 'name',
                                description = 'Description.'
                            }
                        }
                    }
                },
                arguments = { -- Optional
                    {
                        type = 'type',
                        name = 'name',
                        default = 'default argument', -- Optional
                        description = 'Description.',
                        table = { -- If type is table
                            {
                                type = 'string',
                                name = 'name',
                                default = 'nil', -- Optional
                                description = 'Description.'
                            }
                        }
                    }
                }
            }
        }
    }
}

Projects using the LÖVE-API

• ZeroBrane Studio - A lightweight Lua IDE
• LÖVE Atom - Snippets and autocompletion for Atom
• LÖVE Hints - Snippets, code hints and autocompletion for Brackets
• LÖVE-IDEA - Snippets and code completion for IntelliJ IDEA
• Vim LOVE Docs - Syntax highlighting for Vim
• LÖVE API for Notepad++ - Code completion and documentation for Notepad++
• love-eclipse-ldt - Code completion and documentation for Lua Development Tools
• love-ide - Code completion and other tools for Atom
• Quick Reference - Online quick reference of the LÖVE API