Simutrans-Squirrel-API
Public Member Functions | List of all members
line_x Class Reference
Inheritance diagram for line_x:
extend_get ingame_object

Public Member Functions

bool is_valid ()
 
string get_name ()
 
string set_name (string)
 
player_x get_owner ()
 
schedule_x get_schedule ()
 
array< integer > get_goods_catg_index ()
 
array< integer > get_capacity ()
 
array< integer > get_transported_goods ()
 
array< integer > get_convoy_count ()
 
array< integer > get_revenue ()
 
array< integer > get_cost ()
 
array< integer > get_profit ()
 
array< integer > get_traveled_distance ()
 
array< integer > get_way_tolls ()
 
convoy_list_x get_convoy_list ()
 
way_types get_waytype ()
 
string change_schedule (player_x, schedule_x)
 
string destroy (player_x)
 

Detailed Description

Class to access lines.

Definition at line 37 of file api_line.cc.

Member Function Documentation

array<integer> line_x::get_capacity ( )

Get monthly statistics of capacity.

Returns
array, index [0] corresponds to current month
array<integer> line_x::get_convoy_count ( )

Get monthly statistics of number of convoys in this line.

Returns
array, index [0] corresponds to current month
convoy_list_x line_x::get_convoy_list ( )

Exports list of convoys belonging to this line.

array<integer> line_x::get_cost ( )

Get monthly statistics of running costs.

Returns
array, index [0] corresponds to current month
array<integer> line_x::get_goods_catg_index ( )

Returns array of goods categories that can be transported by this convoy.

Returns
array
string line_x::get_name ( )

Line name.

Returns
name
player_x line_x::get_owner ( )

Line owner.

Returns
owner
array<integer> line_x::get_profit ( )

Get monthly statistics of profit.

Returns
array, index [0] corresponds to current month
array<integer> line_x::get_revenue ( )

Get monthly statistics of revenue.

Returns
array, index [0] corresponds to current month
schedule_x line_x::get_schedule ( )

Schedule of this line.

array<integer> line_x::get_transported_goods ( )

Get monthly statistics of number of transported goods.

Returns
array, index [0] corresponds to current month
array<integer> line_x::get_traveled_distance ( )

Get monthly statistics of traveled distance.

Returns
array, index [0] corresponds to current month
array<integer> line_x::get_way_tolls ( )

Get monthly statistics of income/loss due to way tolls.

Returns
array, index [0] corresponds to current month
way_types line_x::get_waytype ( )
Returns
waytype of the line
bool line_x::is_valid ( )
Returns
if object is still valid.

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