Module naev
Naev generic Lua bindings.
Functions
| version () | Gets the version of Naev and the save game. |
| lastplayed () | Gets how many days it has been since the player last played Naev. |
| ticks () | Gets the SDL ticks. |
| keyGet (keyname) | Gets a human-readable name for the key bound to a function. |
| keyEnable (keyname[, enable=false]) | Disables or enables a specific keybinding. |
| keyEnableAll () | Enables all inputs. |
| keyDisableAll () | Disables all inputs. |
| eventStart (evtname) | Starts an event, does not start check conditions. |
| missionStart (misnname) | Starts a mission, does no check start conditions. |
| conf () | Gets the configuration information. |
| cache () | Gets the global Lua runtime cache. |
Functions
- version ()
-
Gets the version of Naev and the save game.
Returns:
- game_version The version of the game.
- save_version Version of current loaded save or nil if not loaded.
Usage:
game_version, save_version = naev.version()
- lastplayed ()
-
Gets how many days it has been since the player last played Naev.
Returns:
-
number
Number of days since the player last played.
- ticks ()
-
Gets the SDL ticks.
Useful for doing timing on Lua functions.
Returns:
-
number
The SDL ticks since the application started running.
- keyGet (keyname)
-
Gets a human-readable name for the key bound to a function.
Parameters:
- keyname string Name of the keybinding to get value of. Valid values are listed in src/input.c: keybind_info.
Usage:
bindname = naev.keyGet( "accel" ) - keyEnable (keyname[, enable=false])
-
Disables or enables a specific keybinding.
Use with caution, this can make the player get stuck.
Parameters:
- keyname string Name of the key to disable (for example "accel").
- enable boolean Whether to enable or disable. (default false)
Usage:
naev.keyEnable( "accel", false ) -- Disables the acceleration key
- keyEnableAll ()
-
Enables all inputs.
Usage:
naev.keyEnableAll() -- Enables all inputs - keyDisableAll ()
-
Disables all inputs.
Usage:
naev.keyDisableAll() -- Disables all inputs - eventStart (evtname)
-
Starts an event, does not start check conditions.
Parameters:
- evtname string Name of the event to start.
Returns:
-
boolean
true on success.
Usage:
naev.eventStart( "Some Event" ) - missionStart (misnname)
-
Starts a mission, does no check start conditions.
Parameters:
- misnname string Name of the mission to start.
Returns:
-
boolean
true on success.
Usage:
naev.missionStart( "Some Mission" ) - conf ()
-
Gets the configuration information.
Returns:
-
table
Table of configuration values as they appear in the configuration file.
- cache ()
-
Gets the global Lua runtime cache. This is shared among all
environments and is cleared when the game is closed.
Returns:
-
table
The Lua global cache.
Usage:
c = naev.cache()