api_simple.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_simple.h"
#include "../api_class.h"
#include "../api_function.h"
#include "../../dataobj/ribi.h"
#include "../../world/simworld.h"
#include "../../dataobj/scenario.h"
 
using namespace script_api;
 
 
#ifdef DOXYGEN
class time_x { // begin_class("time_x")
public:
#ifdef SQAPI_DOC // document members
    integer raw;   
    integer year;  
    integer month; 
#endif
}; // end_class
 
class time_ticks_x : public time_x { // begin_class("time_ticks_x", "time_x")
public:
#ifdef SQAPI_DOC // document members
    integer ticks;            
    integer ticks_per_month;  
    integer next_month_ticks; 
#endif
}; // end_class
#endif
 
// pushes table = { raw = , year = , month = }
SQInteger param<mytime_t>::push(HSQUIRRELVM vm, mytime_t const& v)
{
    sq_newtableex(vm, 6);
    create_slot<uint32>(vm, "raw",   v.raw);
    create_slot<uint32>(vm, "year",  v.raw/12);
    create_slot<uint32>(vm, "month", v.raw%12);
    return 1;
}
 
SQInteger param<mytime_ticks_t>::push(HSQUIRRELVM vm, mytime_ticks_t const& v)
{
    param<mytime_t>::push(vm, v);
    create_slot<uint32>(vm, "ticks",            v.ticks);
    create_slot<uint32>(vm, "ticks_per_month",  v.ticks_per_month);
    create_slot<uint32>(vm, "next_month_ticks", v.next_month_ticks);
    return 1;
}
 
SQInteger param<mytool_data_t>::push(HSQUIRRELVM vm, mytool_data_t const& v)
{
    sq_newtableex(vm, 6);
    create_slot<koord3d>(vm, "start_pos",   v.start_pos);
    create_slot<bool>(vm, "is_drag_tool",   v.is_drag_tool);
    create_slot<bool>(vm, "is_ctrl",        v.is_ctrl);
    create_slot<bool>(vm, "is_shift",       v.is_shift);
    return 1;
}
 
 
mytime_t param<mytime_t>::get(HSQUIRRELVM vm, SQInteger index)
{
    // 0 has special meaning of 'no-timeline'
    SQInteger i=1;
    if (!SQ_SUCCEEDED(sq_getinteger(vm, index, &i))) {
        get_slot(vm, "raw", i, index);
    }
    return (uint16) (i >= 0 ? i : 1);
}
 
 
#define map_ribi_any(f,type) \
    type export_## f(my_ribi_t r) \
    { \
        return ribi_t::f(r); \
    }
 
// export the ribi functions
map_ribi_any(is_single, bool);
map_ribi_any(is_twoway, bool);
map_ribi_any(is_threeway, bool);
map_ribi_any(is_bend, bool);
map_ribi_any(is_straight, bool);
map_ribi_any(doubles, my_ribi_t);
map_ribi_any(backward, my_ribi_t);
 
my_slope_t ribi_to_slope(my_ribi_t ribi)
{
    return slope_type((ribi_t::ribi)ribi);
}
 
my_ribi_t slope_to_ribi(my_slope_t slope)
{
    return ribi_type((slope_t::type)slope);
}
 
 
template<int idx> SQInteger coord_to_ribi(HSQUIRRELVM vm)
{
    // get coordinate vector without transformation
    sint16 x=-1, y=-1;
    get_slot(vm, "x", x, idx);
    get_slot(vm, "y", y, idx);
    koord k(x,y);
 
    // and do not transform ribi either
    uint8 ribi = ribi_type(k);
    return param<uint8>::push(vm, ribi);
}
 
SQInteger ribi_to_coord(HSQUIRRELVM vm)
{
    const uint8 ribi = param<uint8>::get(vm, 2);
    if ((ribi & ~(uint8)ribi_t::all) != 0) {
        return sq_raise_error(vm, "Invalid dir %hhu (valid values are 0..15)", ribi);
    }
 
    koord k( (ribi_t::ribi)ribi );
    return push_instance(vm, "coord", k.x, k.y);
}
 
 
void export_simple(HSQUIRRELVM vm)
{
 
    begin_class(vm, "coord");
#ifdef SQAPI_DOC // document members
    integer x;
    integer y;
    // operators are defined in script_base.nut
    coord(int x, int y);
    coord operator + (coord other);
    coord operator - (coord other);
    coord operator - ();
    coord operator * (integer fac);
    coord operator / (integer fac);
    string _tostring();
    string href(string text);
#endif
    register_function(vm, coord_to_ribi<1>, "to_dir", 1, "t|x|y");
 
    end_class(vm);
 
    begin_class(vm, "coord3d", "coord");
#ifdef SQAPI_DOC // document members
    integer x;
    integer y;
    integer z;
    // operators are defined in script_base.nut
    coord(int x, int y, int z);
    coord3d operator + (coord3d other);
    coord3d operator - (coord other);
    coord3d operator + (coord3d other);
    coord3d operator - (coord other);
    coord3d operator - ();
    coord3d operator * (integer fac);
    coord3d operator / (integer fac);
    string _tostring();
    string href(string text);
#endif
    end_class(vm);
 
    register_function(vm, coord_to_ribi<2>, "coord_to_dir", 2, "x t|x|y");
 
    begin_class(vm, "dir");
 
#ifdef SQAPI_DOC // document members
    static const dir none;
    static const dir north;
    static const dir east;
    static const dir northeast;
    static const dir south;
    static const dir northsouth;
    static const dir southeast;
    static const dir northsoutheast;
    static const dir west;
    static const dir northwest;
    static const dir eastwest;
    static const dir northeastwest;
    static const dir southwest;
    static const dir northsouthwest;
    static const dir southeastwest;
    static const dir all;
#endif
    STATIC register_method(vm, &export_is_single,  "is_single", false, true);
    STATIC register_method(vm, &export_is_twoway,  "is_twoway", false, true);
    STATIC register_method(vm, &export_is_threeway,  "is_threeway", false, true);
    STATIC register_method(vm, &export_is_bend,  "is_curve", false, true);
    STATIC register_method(vm, &export_is_straight,  "is_straight", false, true);
    STATIC register_method(vm, &export_doubles,  "double", false, true);
    STATIC register_method(vm, &export_backward,  "backward", false, true);
 
    STATIC register_method(vm, &ribi_to_slope, "to_slope", false, true);
    STATIC register_function(vm, ribi_to_coord, "to_coord", 2, ".i", true);
 
    end_class(vm);
 
    begin_class(vm, "slope");
 
#ifdef SQAPI_DOC // document members
    static const slope flat;
    static const slope north;      
    static const slope west;       
    static const slope east;       
    static const slope south;      
    static const slope northwest;  
    static const slope northeast;  
    static const slope southeast;  
    static const slope southwest;  
    static const slope raised;     
    static const slope all_up_slope   = 82; 
    static const slope all_down_slope = 83; 
#endif
 
    STATIC register_method(vm, &slope_to_ribi, "to_dir", false, true);
    end_class(vm);
 
#ifdef SQAPI_DOC
    class ingame_object
    {
        bool is_valid();
    }
#endif
}