api_player.cc

Go to the documentation of this file.

/*
 * This file is part of the Simutrans project under the Artistic License.
 * (see LICENSE.txt)
 */

#include "api.h"

#include "../api_class.h"
#include "../api_function.h"
#include "../../player/simplay.h"
#include "../../player/finance.h"

// for creation of lines
#include "../../simline.h"
#include "../../tool/simmenu.h"
#include "../../world/simworld.h"


using namespace script_api;

vector_tpl<sint64> const& get_player_stat(player_t *player, sint32 INDEX, sint32 TTYPE, bool monthly)
{
    static vector_tpl<sint64> v;
    v.clear();
    bool atv = false;
    if (TTYPE<0  ||  TTYPE>=TT_MAX) {
        if (INDEX<0  ||  INDEX>ATC_MAX) {
            return v;
        }
    }
    else {
        if (INDEX<0  ||  INDEX>ATV_MAX) {
            return v;
        }
        atv = true;
    }
    if (player) {
        finance_t *finance = player->get_finance();
        // calculate current month
        finance->calc_finance_history();
        uint16 maxi = monthly ? MAX_PLAYER_HISTORY_MONTHS : MAX_PLAYER_HISTORY_YEARS;
        for(uint16 i = 0; i < maxi; i++) {
            sint64 m = atv ? ( monthly ? finance->get_history_veh_month((transport_type)TTYPE, i, INDEX) : finance->get_history_veh_year((transport_type)TTYPE, i, INDEX) )
                           : ( monthly ? finance->get_history_com_month(i, INDEX) : finance->get_history_com_year(i, INDEX) );
            if (atv) {
                if (INDEX != ATV_TRANSPORTED_PASSENGER  &&  INDEX != ATV_TRANSPORTED_MAIL  &&  INDEX != ATV_TRANSPORTED_GOOD  &&  INDEX !=ATV_TRANSPORTED) {
                    m = convert_money(m);
                }
            }
            else {
                if (INDEX != ATC_ALL_CONVOIS) {
                    m = convert_money(m);
                }
            }
            v.append(m);
        }
    }
    return v;
}


// export of finance_t only here
namespace script_api {
    declare_specialized_param(finance_t*, param<player_t*>::typemask(), param<player_t*>::squirrel_type());

    finance_t* param<finance_t*>::get(HSQUIRRELVM vm, SQInteger index)
    {
        player_t *player = param<player_t*>::get(vm, index);
        return player ? player->get_finance() : NULL;
    }
};
// also export transport_type - to get correct parameters
namespace script_api {
    declare_specialized_param(transport_type, "i", "integer");

    transport_type param<transport_type>::get(HSQUIRRELVM vm, SQInteger index)
    {
        return (transport_type) min(param<uint16>::get(vm, index), TT_MAX-1);
    }
};


SQInteger player_export_line_list(HSQUIRRELVM vm)
{
    if (player_t* player = param<player_t*>::get(vm, 1)) {
        push_instance(vm, "line_list_x");
        set_slot(vm, "player_id", player->get_player_nr());
        return 1;
    }
    return SQ_ERROR;
}

call_tool_init player_create_line(player_t *player, waytype_t wt)
{
    simline_t::linetype lt = simline_t::waytype_to_linetype(wt);
    if (lt == simline_t::MAX_LINE_TYPE) {
        return "Invalid waytype provided";
    }
    // build param string (see schedule_list_gui_t::action_triggered)
    cbuffer_t buf;
    buf.printf( "c,0,%i,0,0|%i|", lt, lt);
    return call_tool_init(TOOL_CHANGE_LINE | SIMPLE_TOOL, buf, 0, player);
}

call_tool_init player_book_account(player_t *player, sint32 delta)
{
    // build param string (see tool_change_player_t)
    cbuffer_t buf;
    buf.printf( "$,%i,%i", player->get_player_nr(), delta);
    return call_tool_init(TOOL_CHANGE_PLAYER | SIMPLE_TOOL, buf, 0, welt->get_public_player());
}

SQInteger player_get_my_player(HSQUIRRELVM vm)
{
    return script_api::param<player_t*>::push(vm, get_my_player(vm) );
}

call_tool_init player_set_name(player_t *player, const char* name)
{
    return script_api::command_rename(player, 'p', player->get_player_nr(), name);
}

void export_player(HSQUIRRELVM vm, bool scenario)
{
    begin_class(vm, "player_x", "extend_get,ingame_object");

    // actually defined in simutrans/script/script_base.nut
    // register_function(..., "constructor", ...);

    export_is_valid<player_t*>(vm); //register_function("is_valid")

    if (!scenario) {
        STATIC register_function(vm, &player_get_my_player, "self", 0, "", true);
    }
    register_method(vm, &player_t::get_headquarter_level, "get_headquarter_level");
    register_method(vm, &player_t::get_headquarter_pos,   "get_headquarter_pos");
    register_method(vm, &player_t::get_name,              "get_name");
    register_method(vm, &player_set_name, "set_name", true);
    register_method_fv(vm, &get_player_stat, "get_construction",      freevariable<sint32,sint32,bool>(ATV_CONSTRUCTION_COST, TT_ALL, true), true);
    register_method_fv(vm, &get_player_stat, "get_vehicle_maint",     freevariable<sint32,sint32,bool>(ATV_RUNNING_COST, TT_ALL, true), true);
    register_method_fv(vm, &get_player_stat, "get_new_vehicles",      freevariable<sint32,sint32,bool>(ATV_NEW_VEHICLE, TT_ALL, true), true);
    register_method_fv(vm, &get_player_stat, "get_income",            freevariable<sint32,sint32,bool>(ATV_REVENUE_TRANSPORT, TT_ALL, true), true);
    register_method_fv(vm, &get_player_stat, "get_maintenance",       freevariable<sint32,sint32,bool>(ATV_INFRASTRUCTURE_MAINTENANCE, TT_ALL, true), true);
    register_method_fv(vm, &get_player_stat, "get_assets",            freevariable<sint32,sint32,bool>(ATV_NON_FINANCIAL_ASSETS, TT_ALL, true), true);
    register_method_fv(vm, &get_player_stat, "get_cash",              freevariable<sint32,sint32,bool>(ATC_CASH, -1, true), true);
    register_method_fv(vm, &get_player_stat, "get_net_wealth",        freevariable<sint32,sint32,bool>(ATC_NETWEALTH, -1, true), true);
    register_method_fv(vm, &get_player_stat, "get_profit",            freevariable<sint32,sint32,bool>(ATV_PROFIT, TT_ALL, true), true);
    register_method_fv(vm, &get_player_stat, "get_operating_profit",  freevariable<sint32,sint32,bool>(ATV_OPERATING_PROFIT, TT_ALL, true), true);
    register_method_fv(vm, &get_player_stat, "get_margin",            freevariable<sint32,sint32,bool>(ATV_PROFIT_MARGIN, -1, true), true);
    register_method_fv(vm, &get_player_stat, "get_transported",       freevariable<sint32,sint32,bool>(ATV_TRANSPORTED, TT_ALL, true), true);
    register_method_fv(vm, &get_player_stat, "get_powerline",         freevariable<sint32,sint32,bool>(ATV_REVENUE, TT_POWERLINE, true), true);
    register_method_fv(vm, &get_player_stat, "get_transported_pax",   freevariable<sint32,sint32,bool>(ATV_TRANSPORTED_PASSENGER, TT_ALL, true), true);
    register_method_fv(vm, &get_player_stat, "get_transported_mail",  freevariable<sint32,sint32,bool>(ATV_TRANSPORTED_MAIL, TT_ALL, true), true);
    register_method_fv(vm, &get_player_stat, "get_transported_goods", freevariable<sint32,sint32,bool>(ATV_TRANSPORTED_GOOD, TT_ALL, true), true);
    register_method_fv(vm, &get_player_stat, "get_convoys",           freevariable<sint32,sint32,bool>(ATC_ALL_CONVOIS, -1, true), true);
    register_method_fv(vm, &get_player_stat, "get_way_tolls",         freevariable<sint32,sint32,bool>(ATV_WAY_TOLL, TT_ALL, true), true);

    if (scenario) {
        register_method(vm, player_book_account, "book_cash", true);
    }
    register_method(vm, &player_t::get_account_balance_as_double, "get_current_cash");
    register_method(vm, &finance_t::get_netwealth, "get_current_net_wealth");
    register_method_fv(vm, &finance_t::get_maintenance_with_bits, "get_current_maintenance", freevariable<uint8>(TT_ALL));
    // register_method(vm,, "is_active", true); implemented in scenario_compat.nut
    register_function(vm, &player_export_line_list, "get_line_list", 1, param<player_t*>::typemask());

    register_method(vm, &player_create_line, "create_line", true);
    register_method(vm, &player_t::get_ai_id, "get_type");

    end_class(vm);
}