api_server_edit.cpp

Go to the documentation of this file.

/*
 Copyright (c) 1996-2020 Freeciv21 and Freeciv contributors. This file is
 part of Freeciv21. Freeciv21 is free software: you can redistribute it
 and/or modify it under the terms of the GNU  General Public License  as
 published by the Free Software Foundation, either version 3 of the
 License,  or (at your option) any later version. You should have received
 a copy of the GNU General Public License along with Freeciv21. If not,
 see https://www.gnu.org/licenses/.
 */
 
// utility
#include "city.h"
#include "cityturn.h"
#include "fcintl.h"
#include "rand.h"
 
// common
#include "movement.h"
#include "research.h"
#include "unittype.h"
/* common/scriptcore */
#include "api_game_find.h"
#include "luascript.h"
 
// server
#include "aiiface.h"
#include "barbarian.h"
#include "citytools.h"
#include "console.h" // enum rfc_status
#include "maphand.h"
#include "notify.h"
#include "plrhand.h"
#include "srv_main.h" // game_was_started()
#include "stdinhand.h"
#include "techtools.h"
#include "unittools.h"
 
/* server/generator */
#include "mapgen_utils.h"
 
#include "api_server_edit.h"
 
bool api_edit_unleash_barbarians(lua_State *L, Tile *ptile)
{
  LUASCRIPT_CHECK_STATE(L, false);
  LUASCRIPT_CHECK_ARG_NIL(L, ptile, 2, Tile, false);
 
  return unleash_barbarians(ptile);
}
 
void api_edit_place_partisans(lua_State *L, Tile *ptile, Player *pplayer,
                              int count, int sq_radius)
{
  LUASCRIPT_CHECK_STATE(L);
  LUASCRIPT_CHECK_ARG_NIL(L, ptile, 2, Tile);
  LUASCRIPT_CHECK_ARG_NIL(L, pplayer, 3, Player);
  LUASCRIPT_CHECK_ARG(L, 0 <= sq_radius, 5, "radius must be positive");
  LUASCRIPT_CHECK(L, 0 < num_role_units(L_PARTISAN),
                  "no partisans in ruleset");
 
  return place_partisans(ptile, pplayer, count, sq_radius);
}
 
Unit *api_edit_create_unit(lua_State *L, Player *pplayer, Tile *ptile,
                           Unit_Type *ptype, int veteran_level,
                           City *homecity, int moves_left)
{
  return api_edit_create_unit_full(L, pplayer, ptile, ptype, veteran_level,
                                   homecity, moves_left, -1, nullptr);
}
 
Unit *api_edit_create_unit_full(lua_State *L, Player *pplayer, Tile *ptile,
                                Unit_Type *ptype, int veteran_level,
                                City *homecity, int moves_left, int hp_left,
                                Unit *ptransport)
{
  struct fc_lua *fcl;
  struct city *pcity;
 
  LUASCRIPT_CHECK_STATE(L, nullptr);
  LUASCRIPT_CHECK_ARG_NIL(L, pplayer, 2, Player, nullptr);
  LUASCRIPT_CHECK_ARG_NIL(L, ptile, 3, Tile, nullptr);
 
  fcl = luascript_get_fcl(L);
 
  LUASCRIPT_CHECK(L, fcl != nullptr, "Undefined Freeciv21 lua state!",
                  nullptr);
 
  if (ptype == nullptr || ptype < unit_type_array_first()
      || ptype > unit_type_array_last()) {
    return nullptr;
  }
 
  if (ptransport) {
    // Extensive check to see if transport and unit are compatible
    int ret;
    struct unit *pvirt =
        unit_virtual_create(pplayer, nullptr, ptype, veteran_level);
    unit_tile_set(pvirt, ptile);
    pvirt->homecity = homecity ? homecity->id : 0;
    ret = can_unit_load(pvirt, ptransport);
    unit_virtual_destroy(pvirt);
    if (!ret) {
      luascript_log(fcl, LOG_ERROR,
                    "create_unit_full: '%s' cannot transport "
                    "'%s' here",
                    utype_rule_name(unit_type_get(ptransport)),
                    utype_rule_name(ptype));
      return nullptr;
    }
  } else if (!can_exist_at_tile(&(wld.map), ptype, ptile)) {
    luascript_log(fcl, LOG_ERROR,
                  "create_unit_full: '%s' cannot exist at "
                  "tile",
                  utype_rule_name(ptype));
    return nullptr;
  }
 
  if (is_non_allied_unit_tile(ptile, pplayer)) {
    luascript_log(fcl, LOG_ERROR,
                  "create_unit_full: tile is occupied by "
                  "enemy unit");
    return nullptr;
  }
 
  pcity = tile_city(ptile);
  if (pcity != nullptr && !pplayers_allied(pplayer, city_owner(pcity))) {
    luascript_log(fcl, LOG_ERROR,
                  "create_unit_full: tile is occupied by "
                  "enemy city");
    return nullptr;
  }
 
  return create_unit_full(pplayer, ptile, ptype, veteran_level,
                          homecity ? homecity->id : 0, moves_left, hp_left,
                          ptransport);
}
 
bool api_edit_unit_teleport(lua_State *L, Unit *punit, Tile *dest)
{
  bool alive;
  struct city *pcity;
 
  LUASCRIPT_CHECK_STATE(L, false);
  LUASCRIPT_CHECK_ARG_NIL(L, punit, 2, Unit, false);
  LUASCRIPT_CHECK_ARG_NIL(L, dest, 3, Tile, false);
 
  // Teleport first so destination is revealed even if unit dies
  alive = unit_move(
      punit, dest, 0,
      /* Auto embark kept for backward compatibility. I have
       * no objection if you see the old behavior as a bug and
       * remove auto embarking completely or for transports
       * the unit can't legally board. -- Sveinung */
      nullptr, true,
      /* Backwards compatibility for old scripts in rulesets
       * and (scenario) savegames. I have no objection if you
       * see the old behavior as a bug and remove auto
       * conquering completely or for cities the unit can't
       * legally conquer. -- Sveinung */
      ((pcity = tile_city(dest))
       && (unit_owner(punit)->ai_common.barbarian_type != ANIMAL_BARBARIAN)
       && uclass_has_flag(unit_class_get(punit), UCF_CAN_OCCUPY_CITY)
       && !unit_has_type_flag(punit, UTYF_CIVILIAN)
       && pplayers_at_war(unit_owner(punit), city_owner(pcity))));
  if (alive) {
    struct player *owner = unit_owner(punit);
 
    if (!can_unit_exist_at_tile(&(wld.map), punit, dest)) {
      wipe_unit(punit, ULR_NONNATIVE_TERR, nullptr);
      return false;
    }
    if (is_non_allied_unit_tile(dest, owner)
        || (pcity && !pplayers_allied(city_owner(pcity), owner))) {
      wipe_unit(punit, ULR_STACK_CONFLICT, nullptr);
      return false;
    }
  }
 
  return alive;
}
 
void api_edit_unit_turn(lua_State *L, Unit *punit, Direction dir)
{
  LUASCRIPT_CHECK_STATE(L);
  LUASCRIPT_CHECK_ARG_NIL(L, punit, 2, Unit);
 
  if (direction8_is_valid(dir)) {
    punit->facing = dir;
 
    send_unit_info(nullptr, punit);
  } else {
    qCritical("Illegal direction %d for unit from lua script", dir);
  }
}
 
void api_edit_unit_kill(lua_State *L, Unit *punit, const char *reason,
                        Player *killer)
{
  enum unit_loss_reason loss_reason;
 
  LUASCRIPT_CHECK_STATE(L);
  LUASCRIPT_CHECK_ARG_NIL(L, punit, 2, Unit);
  LUASCRIPT_CHECK_ARG_NIL(L, reason, 3, string);
 
  loss_reason = unit_loss_reason_by_name(reason, fc_strcasecmp);
 
  LUASCRIPT_CHECK_ARG(L, unit_loss_reason_is_valid(loss_reason), 3,
                      "Invalid unit loss reason");
 
  wipe_unit(punit, loss_reason, killer);
}
 
bool api_edit_change_terrain(lua_State *L, Tile *ptile, Terrain *pterr)
{
  struct terrain *old_terrain;
 
  LUASCRIPT_CHECK_STATE(L, false);
  LUASCRIPT_CHECK_ARG_NIL(L, ptile, 2, Tile, false);
  LUASCRIPT_CHECK_ARG_NIL(L, pterr, 3, Terrain, false);
 
  old_terrain = tile_terrain(ptile);
 
  if (old_terrain == pterr
      || (terrain_has_flag(pterr, TER_NO_CITIES)
          && tile_city(ptile) != nullptr)) {
    return false;
  }
 
  tile_change_terrain(ptile, pterr);
  fix_tile_on_terrain_change(ptile, old_terrain, false);
  if (need_to_reassign_continents(old_terrain, pterr)) {
    assign_continent_numbers();
    send_all_known_tiles(nullptr);
  }
 
  update_tile_knowledge(ptile);
 
  return true;
}
 
void api_edit_create_city(lua_State *L, Player *pplayer, Tile *ptile,
                          const char *name)
{
  LUASCRIPT_CHECK_STATE(L);
  LUASCRIPT_CHECK_ARG_NIL(L, pplayer, 2, Player);
  LUASCRIPT_CHECK_ARG_NIL(L, ptile, 3, Tile);
 
  if (!name || name[0] == '\0') {
    name = city_name_suggestion(pplayer, ptile);
  }
 
  // TODO: Allow initial citizen to be of nationality other than owner
  create_city(pplayer, ptile, name, pplayer);
}
 
void api_edit_resize_city(lua_State *L, City *pcity, int size,
                          const char *reason)
{
  LUASCRIPT_CHECK_STATE(L);
  LUASCRIPT_CHECK_ARG_NIL(L, pcity, 2, City);
 
  LUASCRIPT_CHECK(L, size > 0 && size < MAX_CITY_SIZE, "Invalid city size");
 
  city_change_size(pcity, size, city_owner(pcity), reason);
}
 
Player *api_edit_create_player(lua_State *L, const char *username,
                               Nation_Type *pnation, const char *ai)
{
  struct player *pplayer = nullptr;
  char buf[128] = "";
  struct fc_lua *fcl;
 
  LUASCRIPT_CHECK_STATE(L, nullptr);
  LUASCRIPT_CHECK_ARG_NIL(L, username, 2, string, nullptr);
  if (!ai) {
    ai = default_ai_type_name();
  }
 
  fcl = luascript_get_fcl(L);
 
  LUASCRIPT_CHECK(L, fcl != nullptr, "Undefined Freeciv21 lua state!",
                  nullptr);
 
  if (game_was_started()) {
    create_command_newcomer(username, ai, false, pnation, &pplayer, buf,
                            sizeof(buf));
  } else {
    create_command_pregame(username, ai, false, &pplayer, buf, sizeof(buf));
  }
 
  if (strlen(buf) > 0) {
    luascript_log(fcl, LOG_NORMAL, "%s", buf);
  }
 
  return pplayer;
}
 
void api_edit_change_gold(lua_State *L, Player *pplayer, int amount)
{
  LUASCRIPT_CHECK_STATE(L);
  LUASCRIPT_CHECK_ARG_NIL(L, pplayer, 2, Player);
 
  pplayer->economic.gold = MAX(0, pplayer->economic.gold + amount);
}
 
Tech_Type *api_edit_give_technology(lua_State *L, Player *pplayer,
                                    Tech_Type *ptech, int cost, bool notify,
                                    const char *reason)
{
  struct research *presearch;
  Tech_type_id id;
  Tech_Type *result;
 
  LUASCRIPT_CHECK_STATE(L, nullptr);
  LUASCRIPT_CHECK_ARG_NIL(L, pplayer, 2, Player, nullptr);
  LUASCRIPT_CHECK_ARG(L, cost >= -3, 4, "Unknown give_tech() cost value",
                      nullptr);
 
  presearch = research_get(pplayer);
  if (ptech) {
    id = advance_number(ptech);
  } else {
    id = pick_free_tech(presearch);
  }
 
  if (is_future_tech(id)
      || research_invention_state(presearch, id) != TECH_KNOWN) {
    if (cost < 0) {
      if (cost == -1) {
        cost = game.server.freecost;
      } else if (cost == -2) {
        cost = game.server.conquercost;
      } else if (cost == -3) {
        cost = game.server.diplbulbcost;
      }
    }
    research_apply_penalty(presearch, id, cost);
    found_new_tech(presearch, id, false, true);
    result = advance_by_number(id);
    script_tech_learned(presearch, pplayer, result, reason);
 
    if (notify && result != nullptr) {
      QString adv_name = research_advance_name_translation(presearch, id);
      char research_name[MAX_LEN_NAME * 2];
 
      research_pretty_name(presearch, research_name, sizeof(research_name));
 
      notify_player(pplayer, nullptr, E_TECH_GAIN, ftc_server,
                    Q_("?fromscript:You acquire %s."),
                    qUtf8Printable(adv_name));
      notify_research(presearch, pplayer, E_TECH_GAIN, ftc_server,
                      /* TRANS: "The Greeks ..." or "The members of
                       * team Red ..." */
                      Q_("?fromscript:The %s acquire %s and share this "
                         "advance with you."),
                      nation_plural_for_player(pplayer),
                      qUtf8Printable(adv_name));
      notify_research_embassies(presearch, nullptr, E_TECH_EMBASSY,
                                ftc_server,
                                /* TRANS: "The Greeks ..." or "The members of
                                 * team Red ..." */
                                Q_("?fromscript:The %s acquire %s."),
                                research_name, qUtf8Printable(adv_name));
    }
 
    return result;
  } else {
    return nullptr;
  }
}
 
bool api_edit_trait_mod_set(lua_State *L, Player *pplayer, const char *tname,
                            const int mod)
{
  enum trait tr;
 
  LUASCRIPT_CHECK_STATE(L, -1);
  LUASCRIPT_CHECK_ARG_NIL(L, pplayer, 2, Player, false);
  LUASCRIPT_CHECK_ARG_NIL(L, tname, 3, string, false);
 
  tr = trait_by_name(tname, fc_strcasecmp);
 
  LUASCRIPT_CHECK_ARG(L, trait_is_valid(tr), 3, "no such trait", 0);
 
  pplayer->ai_common.traits[tr].mod += mod;
 
  return true;
}
 
void api_edit_create_owned_extra(lua_State *L, Tile *ptile, const char *name,
                                 Player *pplayer)
{
  struct extra_type *pextra;
 
  LUASCRIPT_CHECK_STATE(L);
  LUASCRIPT_CHECK_ARG_NIL(L, ptile, 2, Tile);
 
  if (!name) {
    return;
  }
 
  pextra = extra_type_by_rule_name(name);
 
  if (pextra) {
    create_extra(ptile, pextra, pplayer);
    update_tile_knowledge(ptile);
  }
}
 
void api_edit_create_extra(lua_State *L, Tile *ptile, const char *name)
{
  api_edit_create_owned_extra(L, ptile, name, nullptr);
}
 
void api_edit_create_base(lua_State *L, Tile *ptile, const char *name,
                          Player *pplayer)
{
  api_edit_create_owned_extra(L, ptile, name, pplayer);
}
 
void api_edit_create_road(lua_State *L, Tile *ptile, const char *name)
{
  api_edit_create_owned_extra(L, ptile, name, nullptr);
}
 
void api_edit_remove_extra(lua_State *L, Tile *ptile, const char *name)
{
  struct extra_type *pextra;
 
  LUASCRIPT_CHECK_STATE(L);
  LUASCRIPT_CHECK_ARG_NIL(L, ptile, 2, Tile);
 
  if (!name) {
    return;
  }
 
  pextra = extra_type_by_rule_name(name);
 
  if (pextra != nullptr && tile_has_extra(ptile, pextra)) {
    tile_extra_rm_apply(ptile, pextra);
    update_tile_knowledge(ptile);
  }
}
 
void api_edit_tile_set_label(lua_State *L, Tile *ptile, const char *label)
{
  LUASCRIPT_CHECK_STATE(L);
  LUASCRIPT_CHECK_SELF(L, ptile);
  LUASCRIPT_CHECK_ARG_NIL(L, label, 3, string);
 
  tile_set_label(ptile, label);
  if (server_state() >= S_S_RUNNING) {
    send_tile_info(nullptr, ptile, false);
  }
}
 
void api_edit_climate_change(lua_State *L, enum climate_change_type type,
                             int effect)
{
  LUASCRIPT_CHECK_STATE(L);
  LUASCRIPT_CHECK_ARG(L,
                      type == CLIMATE_CHANGE_GLOBAL_WARMING
                          || type == CLIMATE_CHANGE_NUCLEAR_WINTER,
                      2, "invalid climate change type");
  LUASCRIPT_CHECK_ARG(L, effect > 0, 3, "effect must be greater than zero");
 
  climate_change(type == CLIMATE_CHANGE_GLOBAL_WARMING, effect);
}
 
Player *api_edit_civil_war(lua_State *L, Player *pplayer, int probability)
{
  LUASCRIPT_CHECK_STATE(L, nullptr);
  LUASCRIPT_CHECK_ARG_NIL(L, pplayer, 2, Player, nullptr);
  LUASCRIPT_CHECK_ARG(L, probability >= 0 && probability <= 100, 3,
                      "must be a percentage", nullptr);
 
  if (!civil_war_possible(pplayer, false, false)) {
    return nullptr;
  }
 
  if (probability == 0) {
    // Calculate chance with normal rules
    if (!civil_war_triggered(pplayer)) {
      return nullptr;
    }
  } else {
    // Fixed chance specified by script
    if (fc_rand(100) >= probability) {
      return nullptr;
    }
  }
 
  return civil_war(pplayer);
}
 
void api_edit_player_victory(lua_State *L, Player *pplayer)
{
  LUASCRIPT_CHECK_STATE(L);
  LUASCRIPT_CHECK_SELF(L, pplayer);
 
  player_status_add(pplayer, PSTATUS_WINNER);
}
 
bool api_edit_unit_move(lua_State *L, Unit *punit, Tile *ptile, int movecost)
{
  struct city *pcity;
 
  LUASCRIPT_CHECK_STATE(L, false);
  LUASCRIPT_CHECK_SELF(L, punit, false);
  LUASCRIPT_CHECK_ARG_NIL(L, ptile, 3, Tile, false);
  LUASCRIPT_CHECK_ARG(L, movecost >= 0, 4, "Negative move cost!", false);
 
  return unit_move(
      punit, ptile, movecost,
      /* Auto embark kept for backward compatibility. I have
       * no objection if you see the old behavior as a bug and
       * remove auto embarking completely or for transports
       * the unit can't legally board. -- Sveinung */
      nullptr, true,
      /* Backwards compatibility for old scripts in rulesets
       * and (scenario) savegames. I have no objection if you
       * see the old behavior as a bug and remove auto
       * conquering completely or for cities the unit can't
       * legally conquer. -- Sveinung */
      ((pcity = tile_city(ptile))
       && (unit_owner(punit)->ai_common.barbarian_type != ANIMAL_BARBARIAN)
       && uclass_has_flag(unit_class_get(punit), UCF_CAN_OCCUPY_CITY)
       && !unit_has_type_flag(punit, UTYF_CIVILIAN)
       && pplayers_at_war(unit_owner(punit), city_owner(pcity))));
}
 
void api_edit_unit_moving_disallow(lua_State *L, Unit *punit)
{
  LUASCRIPT_CHECK_STATE(L);
  LUASCRIPT_CHECK_SELF(L, punit);
 
  if (punit != nullptr) {
    punit->stay = true;
  }
}
 
void api_edit_unit_moving_allow(lua_State *L, Unit *punit)
{
  LUASCRIPT_CHECK_STATE(L);
  LUASCRIPT_CHECK_SELF(L, punit);
 
  if (punit != nullptr) {
    punit->stay = false;
  }
}
 
void api_edit_city_add_history(lua_State *L, City *pcity, int amount)
{
  LUASCRIPT_CHECK_STATE(L);
  LUASCRIPT_CHECK_SELF(L, pcity);
 
  pcity->history += amount;
}
 
void api_edit_player_add_history(lua_State *L, Player *pplayer, int amount)
{
  LUASCRIPT_CHECK_STATE(L);
  LUASCRIPT_CHECK_SELF(L, pplayer);
 
  pplayer->history += amount;
}