server/scripting/api_server_base.c

   1 /*****************************************************************************
   2  Freeciv - Copyright (C) 2005 - The Freeciv Project
   3    This program is free software; you can redistribute it and/or modify
   4    it under the terms of the GNU General Public License as published by
   5    the Free Software Foundation; either version 2, or (at your option)
   6    any later version.
   7
   8    This program is distributed in the hope that it will be useful,
   9    but WITHOUT ANY WARRANTY; without even the implied warranty of
  10    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11    GNU General Public License for more details.
  12 *****************************************************************************/
  13
  14 #ifdef HAVE_CONFIG_H
  15 #include <fc_config.h>
  16 #endif
  17
  18 /* common/scriptcore */
  19 #include "luascript.h"
  20
  21 /* server */
  22 #include "savegame.h"
  23 #include "score.h"
  24 #include "settings.h"
  25 #include "srv_main.h"
  26
  27 /* server/scripting */
  28 #include "script_server.h"
  29
  30 #include "api_server_base.h"
  31
  32 /*****************************************************************************
  33   Return the civilization score (total) for player
  34 *****************************************************************************/
  35 int api_server_player_civilization_score(lua_State *L, Player *pplayer)
  36 {
  37   LUASCRIPT_CHECK_STATE(L, 0);
  38   LUASCRIPT_CHECK_SELF(L, pplayer, 0);
  39
  40   return get_civ_score(pplayer);
  41 }
  42
  43 /*****************************************************************************
  44   Returns TRUE if the game was started.
  45 *****************************************************************************/
  46 bool api_server_was_started(lua_State *L)
  47 {
  48   LUASCRIPT_CHECK_STATE(L, FALSE);
  49
  50   return game_was_started();
  51 }
  52
  53 /*****************************************************************************
  54   Save the game (a manual save is triggered).
  55 *****************************************************************************/
  56 bool api_server_save(lua_State *L, const char *filename)
  57 {
  58   LUASCRIPT_CHECK_STATE(L, FALSE);
  59
  60   /* Limit the allowed characters in the filename. */
  61   if (filename != NULL && !is_safe_filename(filename)) {
  62     return FALSE;
  63   }
  64
  65   save_game(filename, "User request (Lua)", FALSE);
  66
  67   return TRUE;
  68 }
  69
  70 /*****************************************************************************
  71   Play music track for player
  72 *****************************************************************************/
  73 bool api_play_music(lua_State *L, Player *pplayer, const char *tag)
  74 {
  75   struct packet_play_music p;
  76
  77   LUASCRIPT_CHECK_STATE(L, FALSE);
  78   LUASCRIPT_CHECK_SELF(L, pplayer, FALSE);
  79   LUASCRIPT_CHECK_ARG_NIL(L, tag, 3, API_TYPE_STRING, FALSE);
  80
  81   strncpy(p.tag, tag, sizeof(p.tag));
  82
  83   lsend_packet_play_music(pplayer->connections, &p);
  84
  85   return TRUE;
  86 }
  87
  88 /*****************************************************************************
  89   Return the formated value of the setting or NULL if no such setting exists,
  90 *****************************************************************************/
  91 const char *api_server_setting_get(lua_State *L, const char *sett_name)
  92 {
  93   struct setting *pset;
  94   static char buf[512];
  95
  96   LUASCRIPT_CHECK_STATE(L, NULL);
  97   LUASCRIPT_CHECK_ARG_NIL(L, sett_name, 2, API_TYPE_STRING, NULL);
  98
  99   pset = setting_by_name(sett_name);
 100
 101   if (!pset) {
 102     return NULL;
 103   }
 104
 105   return setting_value_name(pset, FALSE, buf, sizeof(buf));
 106 }