Inheritance diagram for way_x:

Public Member Functions
array< integer >	get_convoys_passed ()

way_desc_x	get_desc ()

dir	get_dirs ()

dir	get_dirs_masked ()

integer	get_max_speed ()

array< integer >	get_transported_goods ()

bool	has_sidewalk ()

bool	has_sign ()

bool	has_signal ()

bool	has_wayobj ()

bool	is_crossing ()

bool	is_electrified ()

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 ()

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

Ways.

Definition at line 162 of file api_map_objects.cc.

Member Function Documentation

◆ get_convoys_passed()

array<integer> way_x::get_convoys_passed ( )

Get monthly statistics of convoys that used this way.

Returns: array, index [0] corresponds to current month

◆ get_desc()

way_desc_x way_x::get_desc ( )

Returns: object descriptor.

◆ get_dirs()

dir way_x::get_dirs ( )

Return directions of this way. One-way signs are ignored here.

Returns: direction

◆ get_dirs_masked()

dir way_x::get_dirs_masked ( )

Return directions of this way. Some signs restrict available directions.

Returns: direction

◆ get_max_speed()

integer way_x::get_max_speed ( )

Returns maximal allowed speed on this way. Takes limits from crossings, overhead-wires, bridges, etc, into account.

Returns: max speed in kmh.

◆ get_transported_goods()

array<integer> way_x::get_transported_goods ( )

Get monthly statistics of goods transported on this way.

Returns: array, index [0] corresponds to current month

◆ has_sidewalk()

bool way_x::has_sidewalk ( )

Returns: if this way has sidewalk - only meaningful for roads

◆ has_sign()

bool way_x::has_sign ( )

Returns: whether there is a road-sign associated to the way on the tile

◆ has_signal()

bool way_x::has_signal ( )

Returns: whether there is a signal associated to the way on the tile

◆ has_wayobj()

bool way_x::has_wayobj ( )

Returns: whether there is a way-object associated to the way on the tile

◆ is_crossing()

bool way_x::is_crossing ( )

Returns: whether there is a crossing associated to the way on the tile

◆ is_electrified()

bool way_x::is_electrified ( )

Returns: whether way is electrified by some way-object

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

api_map_objects.cc

Public Member Functions

Additional Inherited Members