Package horizons :: Package world :: Package units :: Module ship :: Class Ship
[hide private]
[frames] | no frames]

Class Ship

source code

 component.componentholder.ComponentHolder --+        
                                             |        
util.changelistener.ChangeListener --+       |        
                                     |       |        
          util.worldobject.WorldObject --+   |        
                                         |   |        
             concreteobject.ConcreteObject --+        
                                             |        
                     movingobject.MovingObject --+    
                                                 |    
       resourcehandler.ResourceTransferHandler --+    
                                                 |    
                                         unit.Unit --+
                                                     |
                                                    Ship

Class representing a ship

Instance Methods [hide private]
 
__init__(self, x, y, **kwargs) source code
 
save(self, db) source code
 
load(self, db, worldid) source code
 
__init(self) source code
 
set_name(self, name) source code
 
remove(self) source code
 
create_route(self) source code
 
_move_tick(self, resume=False)
Keeps track of the ship's position in the global ship_map
source code
 
_movement_finished(self) source code
 
go(self, x, y) source code
 
move(self, *args, **kwargs)
Moves unit to destination
source code
 
_update_buoy(self, remove_only=False)
Draw a buoy at the move target if the ship is moving.
source code
 
find_nearby_ships(self, radius=15) source code
 
get_tradeable_warehouses(self, position=None)
Returns warehouses this ship can trade with w.r.t.
source code
 
get_location_based_status(self, position) source code
 
get_status(self)
Return the current status of the ship.
source code
    Inherited from unit.Unit
 
__str__(self) source code
 
_on_damage(self, caller=None)
Called when health has changed
source code
 
classname(self) source code
 
draw_health(self, remove_only=False, auto_remove=False)
Draws the units current health as a healthbar over the unit.
source code
 
get_random_location(self, in_range)
Returns a random location in walking_range, that we can find a path to Does not check every point, only a few samples are tried.
source code
 
hide(self)
Hides the unit.
source code
 
onInstanceActionCancelled(self, instance, action) source code
 
onInstanceActionFinished(self, instance, action) source code
 
show(self) source code
    Inherited from movingobject.MovingObject
 
_setup_move(self, action='move')
Executes necessary steps to begin a movement.
source code
 
add_blocked_callback(self, blocked_callback)
Registers callback to be executed when movement of the unit gets blocked.
source code
 
add_conditional_callback(self, condition, callback)
Adds a callback, that gets called, if, at any time of the movement, the condition becomes True.
source code
 
add_move_callback(self, callback)
Registers callback to be executed when movement of unit finishes.
source code
 
check_move(self, destination)
Tries to find a path to destination
source code
 
get_move_target(self) source code
 
get_unit_velocity(self)
Returns the number of ticks that it takes to do a straight (i.e.
source code
 
is_moving(self)
Returns whether unit is currently moving
source code
 
stop(self, callback=None)
Stops a unit with currently no possibility to continue the movement.
source code
 
teleport(self, destination, callback=None, destination_in_building=False)
Like move, but nearly instantaneous
source code
    Inherited from component.componentholder.ComponentHolder
 
add_component(self, component)
Adds new component to holder and sets the instance attribute on the component
source code
 
get_component(self, component) source code
 
get_component_by_name(self, name) source code
 
has_component(self, component_class)
Check if holder has component with component name
source code
 
initialize(self, **kwargs)
Has to be called every time a componentholder is created.
source code
 
remove_component(self, component_class)
Removes component from holder.
source code
    Inherited from concreteobject.ConcreteObject
 
act(self, action, facing_loc=None, repeating=False, force_restart=True) source code
 
fife_instance(self) source code
 
has_action(self, action)
Checks if this unit has a certain action.
source code
 
name(self) source code
    Inherited from util.worldobject.WorldObject
 
__lt__(self, other) source code
    Inherited from util.changelistener.ChangeListener
 
_changed(self)
Calls every listener when an object changed
source code
 
add_change_listener(self, listener, call_listener_now=False, no_duplicates=False) source code
 
add_remove_listener(self, listener, no_duplicates=False)
A listener that listens for removal of the object
source code
 
clear_change_listeners(self)
Removes all change listeners
source code
 
discard_change_listener(self, listener)
Remove listener if it's there
source code
 
discard_remove_listener(self, listener) source code
 
end(self) source code
 
has_change_listener(self, listener) source code
 
has_remove_listener(self, listener) source code
 
remove_change_listener(self, listener) source code
 
remove_remove_listener(self, listener) 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 Methods [hide private]
    Inherited from component.componentholder.ComponentHolder
 
get_component_template(cls, component)
Returns the component template data given a component NAME
source code
    Inherited from concreteobject.ConcreteObject
 
get_random_action_set(cls, level=0, exact_level=False)
Returns an action set for an object of type object_id in a level <= the specified level.
source code
 
weighted_choice(cls, weighted_dict)
http://eli.thegreenplace.net/2010/01/22/weighted-random-generation-in-python/
source code
    Inherited from util.worldobject.WorldObject
 
get_object_by_id(cls, id)
Returns the worldobject with id id Throws WorldObjectNotFound with the worldid as arg.
source code
 
get_objs(cls) source code
 
reset(cls) source code
Class Variables [hide private]
  pather_class = ShipPather
hash(x)
  health_bar_y = -150
  is_ship = True
  in_ship_map = True
    Inherited from unit.Unit
  AUTOMATIC_HEALTH_DISPLAY_TIMEOUT = 10
  is_unit = True
  log = logging.getLogger("world.units")
    Inherited from movingobject.MovingObject
  movable = True
    Inherited from component.componentholder.ComponentHolder
  class_mapping = {'AmbientSoundComponent': AmbientSoundComponen...
    Inherited from concreteobject.ConcreteObject
  is_building = False
Method Details [hide private]

__init__(self, x, y, **kwargs)
(Constructor)

source code 
Parameters:
  • x - int x position
  • y - int y position
Overrides: util.changelistener.ChangeListener.__init__

save(self, db)

source code 
Overrides: util.worldobject.WorldObject.save

load(self, db, worldid)

source code 
Overrides: util.changelistener.ChangeListener.load

remove(self)

source code 
Overrides: util.changelistener.ChangeListener.remove

_move_tick(self, resume=False)

source code 

Keeps track of the ship's position in the global ship_map

Overrides: movingobject.MovingObject._move_tick

_movement_finished(self)

source code 
Overrides: movingobject.MovingObject._movement_finished

go(self, x, y)

source code 
Overrides: unit.Unit.go

move(self, *args, **kwargs)

source code 

Moves unit to destination

Parameters:
  • destination - Point or Rect
  • callback - a parameter supported by WeakMethodList. Gets called when unit arrives.
  • action - action as string to use for movement
  • blocked_callback - a parameter supported by WeakMethodList. Gets called when unit gets blocked.
  • path - a precalculated path (return value of FindPath()())
Overrides: movingobject.MovingObject.move
(inherited documentation)

get_tradeable_warehouses(self, position=None)

source code 

Returns warehouses this ship can trade with w.r.t. position, which defaults to the ships ones.