src/nlua_cli.c

   1 /*
   2  * See Licensing and Copyright notice in naev.h
   3  */
   4
   5 /**
   6  * @file nlua_cli.c
   7  *
   8  * @brief Contains Lua bindings for the console.
   9  */
  10
  11 #include "nlua_cli.h"
  12
  13 #include "naev.h"
  14
  15 #include "lauxlib.h"
  16
  17 #include "nlua.h"
  18 #include "nluadef.h"
  19 #include "log.h"
  20 #include "mission.h"
  21
  22
  23 /* CLI */
  24 static int cli_missionStart( lua_State *L );
  25 static int cli_missionTest( lua_State *L );
  26 static const luaL_reg cli_methods[] = {
  27    { "missionStart", cli_missionStart },
  28    { "missionTest", cli_missionTest },
  29    {0,0}
  30 }; /**< CLI Lua methods. */
  31
  32
  33 /**
  34  * @brief Loads the CLI Lua library.
  35  *
  36  *    @param L Lua state.
  37  *    @return 0 on success.
  38  */
  39 int nlua_loadCLI( lua_State *L )
  40 {
  41    luaL_register(L, "cli", cli_methods);
  42    return 0;
  43 }
  44
  45 /**
  46  * @brief CLI generic Lua bindings.
  47  *
  48  * An example would be:
  49  * @code
  50  * cli.mission("Pirate Bounty") -- Triggers the Pirate Bounty mission.
  51  * @endcode
  52  *
  53  * @luamod cli
  54  */
  55 /**
  56  * @brief Starts a mission without testing conditionals.
  57  *
  58  * @usage cli.missionStart( "Pirate Bounty" )
  59  *
  60  *    @luaparam misn Name of the mission to start.
  61  * @luafunc missionStart( misn )
  62  */
  63 static int cli_missionStart( lua_State *L )
  64 {
  65    const char *str;
  66
  67    str = luaL_checkstring(L, 1);
  68    if (mission_start( str )) {
  69       NLUA_ERROR(L,"Failed to start mission.");
  70       return 0;
  71    }
  72
  73    return 0;
  74 }
  75
  76 /**
  77  * @brief Starts a mission by testing all the conditionals.
  78  *
  79  * @usage cli.missionTest( "Pirate Bounty" )
  80  *
  81  *    @luaparam misn Name of the mission to start.
  82  * @luafunc missionTest( misn )
  83  */
  84 static int cli_missionTest( lua_State *L )
  85 {
  86    const char *str;
  87
  88    str = luaL_checkstring(L, 1);
  89    if (mission_start( str )) {
  90       NLUA_ERROR(L,"Failed to start mission.");
  91       return 0;
  92    }
  93
  94    return 0;
  95 }
  96