Inheritance diagram for line_x:
Public Member Functions | |
| void | change_schedule (player_x, schedule_x) |
| void | destroy (player_x) |
| array< integer > | get_capacity () |
| array< integer > | get_convoy_count () |
| convoy_list_x | get_convoy_list () |
| array< integer > | get_cost () |
| array< integer > | get_goods_catg_index () |
| string | get_name () |
| player_x | get_owner () |
| array< integer > | get_profit () |
| array< integer > | get_revenue () |
| schedule_x | get_schedule () |
| array< integer > | get_transported_goods () |
| array< integer > | get_traveled_distance () |
| array< integer > | get_way_tolls () |
| way_types | get_waytype () |
| bool | is_valid () |
| void | set_name (string) |
Detailed Description
Class to access lines.
Definition at line 37 of file api_line.cc.
Member Function Documentation
◆ get_capacity()
| array<integer> line_x::get_capacity | ( | ) |
Get monthly statistics of capacity.
- Returns
- array, index [0] corresponds to current month
◆ get_convoy_count()
| 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
◆ get_convoy_list()
| convoy_list_x line_x::get_convoy_list | ( | ) |
Exports list of convoys belonging to this line.
◆ get_cost()
| array<integer> line_x::get_cost | ( | ) |
Get monthly statistics of running costs.
- Returns
- array, index [0] corresponds to current month
◆ get_goods_catg_index()
| array<integer> line_x::get_goods_catg_index | ( | ) |
Returns array of goods categories that can be transported by this convoy.
- Returns
- array
◆ get_name()
| string line_x::get_name | ( | ) |
Line name.
- Returns
- name
◆ get_owner()
| player_x line_x::get_owner | ( | ) |
Line owner.
- Returns
- owner
◆ get_profit()
| array<integer> line_x::get_profit | ( | ) |
Get monthly statistics of profit.
- Returns
- array, index [0] corresponds to current month
◆ get_revenue()
| array<integer> line_x::get_revenue | ( | ) |
Get monthly statistics of revenue.
- Returns
- array, index [0] corresponds to current month
◆ get_schedule()
| schedule_x line_x::get_schedule | ( | ) |
Schedule of this line.
◆ get_transported_goods()
| array<integer> line_x::get_transported_goods | ( | ) |
Get monthly statistics of number of transported goods.
- Returns
- array, index [0] corresponds to current month
◆ get_traveled_distance()
| array<integer> line_x::get_traveled_distance | ( | ) |
Get monthly statistics of traveled distance.
- Returns
- array, index [0] corresponds to current month
◆ get_way_tolls()
| 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
◆ get_waytype()
| way_types line_x::get_waytype | ( | ) |
- Returns
- waytype of the line
◆ is_valid()
| bool line_x::is_valid | ( | ) |
- Returns
- if object is still valid.
The documentation for this class was generated from the following file:
