Package horizons :: Package world :: Package units :: Module animal :: Class CollectorAnimal
[hide private]
[frames] | no frames]

Class CollectorAnimal

source code

resourcehandler.ResourceTransferHandler --+        
                                          |        
            resourcehandler.ResourceHandler --+    
                                              |    
                                         Animal --+
                                                  |
                                                 CollectorAnimal

Animals that will inherit from collector

Instance Methods [hide private]
 
__init__(self, **kwargs) source code
 
__init(self) source code
 
load(self, db, worldid) source code
 
apply_state(self, state, remaining_ticks=None) source code
 
stop_after_job(self, collector)
Tells the unit to stop after the current job and call the collector to pick it up
source code
 
remove_stop_after_job(self)
Let the animal continue as usual after the job.
source code
 
has_collectors(self)
Whether this unit is just now or about to be collected
source code
 
finish_working(self) source code
 
search_job(self)
Search for a job, only called if the collector does not have a job.
source code
 
get_home_inventory(self) source code
 
get_collectable_res(self) source code
    Inherited from resourcehandler.ResourceHandler
 
_get_owner_inventory(self)
Returns the inventory of the owner to be able to retrieve special resources such as gold.
source code
 
_load_provided_resources(self)
Returns a iterable obj containing all resources this building provides.
source code
 
add_incoming_collector(self, collector) source code
 
get_available_pickup_amount(self, res, collector)
Returns how much of res a collector may pick up.
source code
 
get_consumed_resources(self, include_inactive=False)
Returns the needed resources that are used by the productions currently active.
source code
 
get_currently_consumed_resources(self)
Returns a list of resources, that are currently consumed in a production.
source code
 
get_currently_not_consumed_resources(self)
Needed, but not currently consumed resources.
source code
 
get_needed_resources(self)
Returns list of resources, where free space in the inventory exists.
source code
 
get_produced_resources(self)
Returns the resources, that are produced by productions, that are currently active
source code
 
get_stocked_provided_resources(self)
Returns provided resources, where at least 1 ton is available
source code
 
initialize(self) source code
 
pickup_resources(self, res, amount, collector)
Try to get amount number of resources of id res_id that are in stock and removes them from the stock.
source code
 
remove(self) source code
 
remove_incoming_collector(self, collector) source code
 
save(self, db) source code
    Inherited from resourcehandler.ResourceTransferHandler
 
transfer_to_storageholder(self, amount, res_id, transfer_to, signal_errors=False)
Transfers amount of res_id to transfer_to.
source code
Class Variables [hide private]
    Inherited from Animal
  log = logging.getLogger('world.units.animal')
    Inherited from resourcehandler.ResourceHandler
  tabs = ProductionOverviewTab, InventoryTab
Method Details [hide private]

__init__(self, **kwargs)
(Constructor)

source code 
Overrides: resourcehandler.ResourceHandler.__init__

load(self, db, worldid)

source code 
Overrides: resourcehandler.ResourceHandler.load

remove_stop_after_job(self)

source code 

Let the animal continue as usual after the job. Can only be called after stop_after_job