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

Public Member Functions

factory_x get_factory ()
 
city_x get_city ()
 
bool is_townhall ()
 
bool is_headquarter ()
 
bool is_monument ()
 
integer get_passenger_level ()
 
integer get_mail_level ()
 
building_desc_x get_desc ()
 
bool is_same_building (building_x)
 
- Public Member Functions inherited from map_object_x
 map_object_x (integer x, integer y, integer z, map_objects type)
 
bool is_valid ()
 
player_x get_owner ()
 
string get_name ()
 
way_types get_waytype ()
 
coord3d get_pos ()
 
string is_removable (player_x)
 
map_objects get_type ()
 
void mark ()
 
void unmark ()
 
bool is_marked ()
 

Detailed Description

Buildings.

Definition at line 77 of file api_map_objects.cc.

Member Function Documentation

city_x building_x::get_city ( )
Returns
city if building belongs to one, otherwise null
building_desc_x building_x::get_desc ( )
Returns
object descriptor.
factory_x building_x::get_factory ( )
Returns
factory if building belongs to one, otherwise null
integer building_x::get_mail_level ( )

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

Returns
mail level
integer building_x::get_passenger_level ( )

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

Returns
passenger level
bool building_x::is_headquarter ( )
Returns
whether building is headquarters
bool building_x::is_monument ( )
Returns
whether building is a monument
bool building_x::is_same_building ( building_x  )
Returns
true if both building tiles are part of one (multi-tile) building
bool building_x::is_townhall ( )
Returns
whether building is townhall

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