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

Public Member Functions

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

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

Buildings.

Definition at line 78 of file api_map_objects.cc.

Member Function Documentation

◆ get_city()

city_x building_x::get_city ( )
Returns
city if building belongs to one, otherwise null

◆ get_desc()

building_desc_x building_x::get_desc ( )
Returns
object descriptor.

◆ get_factory()

factory_x building_x::get_factory ( )
Returns
factory if building belongs to one, otherwise null

◆ get_mail_level()

integer building_x::get_mail_level ( )

Mail level controls how many mail will be generated by this building.

Returns
mail level

◆ get_passenger_level()

integer building_x::get_passenger_level ( )

Passenger level controls how many passengers will be generated by this building.

Returns
passenger level

◆ get_tile_list()

array<tile_x> building_x::get_tile_list ( )
Returns
coord for all tiles

◆ is_headquarter()

bool building_x::is_headquarter ( )
Returns
whether building is headquarters

◆ is_monument()

bool building_x::is_monument ( )
Returns
whether building is a monument

◆ is_same_building()

bool building_x::is_same_building ( building_x  )
Returns
true if both building tiles are part of one (multi-tile) building

◆ is_townhall()

bool building_x::is_townhall ( )
Returns
whether building is townhall

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