Simutrans-Squirrel-API
Public Member Functions | Static Public Member Functions | List of all members
depot_x Class Reference
Inheritance diagram for depot_x:
building_x map_object_x coord3d extend_get ingame_object coord

Public Member Functions

void append_vehicle (player_x pl, convoy_x cnv, vehicle_desc_x desc)
 
array< convoy_xget_convoy_list ()
 
void start_all_convoys (player_x)
 
void start_convoy (player_x, convoy_x)
 
- Public Member Functions inherited from building_x
city_x get_city ()
 
building_desc_x get_desc ()
 
factory_x get_factory ()
 
integer get_mail_level ()
 
integer get_passenger_level ()
 
array< tile_xget_tile_list ()
 
bool is_headquarter ()
 
bool is_monument ()
 
bool is_same_building (building_x)
 
bool is_townhall ()
 
- Public Member Functions inherited from map_object_x
string get_name ()
 
player_x get_owner ()
 
coord3d get_pos ()
 
map_objects get_type ()
 
way_types get_waytype ()
 
bool is_marked ()
 
string is_removable (player_x)
 
bool is_valid ()
 
 map_object_x (integer x, integer y, integer z, map_objects type)
 
void mark ()
 
void unmark ()
 
- Public Member Functions inherited from coord3d
string _tostring ()
 
 coord (int x, int y, int z)
 
string href (string text)
 
coord3d operator* (integer fac)
 
coord3d operator+ (coord3d other)
 
coord3d operator+ (coord3d other)
 
coord3d operator- (coord other)
 
coord3d operator- (coord other)
 
coord3d operator- ()
 
coord3d operator/ (integer fac)
 
- Public Member Functions inherited from coord
string _tostring ()
 
 coord (int x, int y)
 
string href (string text)
 
coord operator* (integer fac)
 
coord operator+ (coord other)
 
coord operator- (coord other)
 
coord operator- ()
 
coord operator/ (integer fac)
 
dir to_dir ()
 

Static Public Member Functions

static array< depot_xget_depot_list (player_x pl, way_types wt)
 

Additional Inherited Members

- Public Attributes inherited from coord3d
integer x
 x-coordinate
 
integer y
 y-coordinate
 
integer z
 z-coordinate - height
 
- Public Attributes inherited from coord
integer x
 x-coordinate
 
integer y
 y-coordinate
 

Detailed Description

Class to access depots. Main purpose is the manipulation of convoys in depots.

Definition at line 127 of file api_map_objects.cc.

Member Function Documentation

◆ get_convoy_list()

array<convoy_x> depot_x::get_convoy_list ( )
Returns
list of convoys sitting in this depot

◆ get_depot_list()

static array<depot_x> depot_x::get_depot_list ( player_x  pl,
way_types  wt 
)
static

List of all depots of player pl of way-type wt

Parameters
pl
wt
Returns
depot list of player

The documentation for this class was generated from the following file: