Home
Naev Lua API

This is the API used in Naev to interact with the game from Lua.

Lua is a relatively simple scripting language used for a large portion of Naev's content. Missions, events, GUIs and AIs are all written using Lua and Naev's API, as are many minor features such as system backgrounds, reputation handling and others.

The Wiki has an in-depth mission tutorial covering both missions and events, and the API documentation provides common usage examples for each function.

Most API modules can also be used from the in-game Lua console (accessible by pressing F2 by default) for cheating experimenting to your heart's content.

Modules

bkg Lua bindings to interact with the background.
camera Lua bindings to interact with the Camera.
colour Lua bindings to interact with colours.
commodity Lua bindings to interact with commodities.
diff Lua bindings to apply/remove Universe Diffs.
evt Event system Lua bindings.
faction Lua bindings to deal with factions.
gfx Lua bindings to interact with rendering and the Naev graphical environment.
gui Lua bindings to interact with the GUI elements.
hook Lua bindings to manipulate hooks.
jump This module allows you to handle the jumps from Lua.
misn Mission Lua bindings.
music Music Lua module.
naev Naev generic Lua bindings.
news Lua bindings to interact with the news.
outfit Lua bindings to interact with outfits.
pilot Lua bindings to interact with pilots.
planet This module allows you to handle the planets from Lua.
player Lua bindings to interact with the player.
rnd Bindings for interacting with the random number generator.
ship Lua bindings to interact with ships.
system Lua system module.
tex Lua bindings to interact with OpenGL textures.
time Bindings for interacting with the time.
tk Bindings for interacting with the Toolkit.
tut Tutorial generic Lua bindings.
var Mission variable Lua bindings.
vec2 Represents a 2D vector in Lua.

Valid XHTML 1.0!