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

Public Member Functions

array< integer > get_storage ()
 
array< integer > get_received ()
 
array< integer > get_consumed ()
 
array< integer > get_in_transit ()
 
array< integer > get_delivered ()
 
array< integer > get_produced ()
 
integer get_base_production ()
 
integer get_base_consumption ()
 
integer get_consumption_factor ()
 
integer get_production_factor ()
 

Public Attributes

integer max_storage
 

Detailed Description

Class to access storage slots of factories. Are automatically instantiated by factory_x constructor.

Definition at line 165 of file api_factory.cc.

Member Function Documentation

integer factory_production_x::get_base_consumption ( )

Returns base maximum consumption of this good per month. Does not take any productivity boost into account.

integer factory_production_x::get_base_production ( )

Returns base maximum production of this good per month. Does not take any productivity boost into account.

array<integer> factory_production_x::get_consumed ( )

Get monthly statistics of consumed goods (for input slots).

Returns
array, index [0] corresponds to current month
integer factory_production_x::get_consumption_factor ( )

Returns number of consumed units of this good for the production of 100 units of generic outputs unit. Does not take any productivity boost into account.

array<integer> factory_production_x::get_delivered ( )

Get monthly statistics of delivered goods (for output slots).

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

Get monthly statistics of in-transit goods (for input slots).

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

Get monthly statistics of produced goods (for output slots).

Returns
array, index [0] corresponds to current month
integer factory_production_x::get_production_factor ( )

Returns number of produced units of this good due to the production of 100 units of generic outputs unit. Does not take any productivity boost into account.

array<integer> factory_production_x::get_received ( )

Get monthly statistics of received goods (for input slots).

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

Get monthly statistics of storage.

Returns
array, index [0] corresponds to current month

Member Data Documentation

integer factory_production_x::max_storage

Maximum storage of this slot.

Definition at line 170 of file api_factory.cc.


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