Package horizons :: Package gui :: Package mousetools :: Module attackingtool :: Class AttackingTool
[hide private]
[frames] | no frames]

Class AttackingTool

source code

              object --+                
                       |                
fife.fife.IMouseListener --+            
                           |            
       cursortool.CursorTool --+        
                               |        
   navigationtool.NavigationTool --+    
                                   |    
         selectiontool.SelectionTool --+
                                       |
                                      AttackingTool

This will be used when attacking units are selected it will have to respond on right click and change cursor image when hovering enemy units

Instance Methods [hide private]
 
__init__(self, session)
__init__(FIFE::IMouseListener self) -> IMouseListener
source code
 
mousePressed(self, evt)
mousePressed(IMouseListener self, MouseEvent evt)
source code
 
mouseMoved(self, evt)
mouseMoved(IMouseListener self, MouseEvent evt)
source code
 
_get_attackable_instance(self, evt)
Returns target instance if mouse is over an attackable instance Returns None if mouse is not over an attackable instance
source code

Inherited from fife.fife.IMouseListener: __disown__, __repr__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

    Inherited from selectiontool.SelectionTool
 
_draw_rect_line(self, start, end) source code
 
_update_selection(self, instances, do_multi=False)
self.select_old are old instances still relevant now (esp.
source code
 
apply_select(self)
Called when selected instances changes.
source code
 
fife_instance_to_uh_instance(self, instance)
Visual fife instance to uh game logic object or None
source code
 
filter_component(self, component, instances)
Only get specific component from a list of world objects
source code
 
filter_owner(self, instances)
Only keep instances belonging to the user.
source code
 
filter_selectable(self, instances)
Only keeps selectables from a list of world objects
source code
 
is_owned_by_player(self, instance)
Returns boolean if single world object is owned by local player
source code
 
is_selectable(self, entity) source code
 
mouseDragged(self, evt)
mouseDragged(IMouseListener self, MouseEvent evt)
source code
 
mouseReleased(self, evt)
mouseReleased(IMouseListener self, MouseEvent evt)
source code
 
remove(self) source code
    Inherited from navigationtool.NavigationTool
 
_schedule_hover_instance_update(self)
Hover instances have potentially changed, do an update in a timely fashion (but not right away)
source code
 
_send_hover_instance_upate(self)
Broadcast update with new instances below mouse (hovered).
source code
 
end(self) source code
 
get_hover_instances(self, where, layers=None)
Utility method, returns the instances under the cursor
source code
 
mouseWheelMovedDown(self, evt)
mouseWheelMovedDown(IMouseListener self, MouseEvent evt)
source code
 
mouseWheelMovedUp(self, evt)
mouseWheelMovedUp(IMouseListener self, MouseEvent evt)
source code
 
onCommand(self, command)
Called when some kind of command-event happens.
source code
    Inherited from cursortool.CursorTool
 
_get_screenpoint(self, arg)
Python lacks polymorphism.
source code
 
_round_map_coords(self, map_x, map_y)
Returns the coordinates of an event at the map.
source code
 
disable(self)
Call this to not get events.
source code
 
enable(self)
Call this to get events.
source code
 
get_exact_world_location(self, evt)
Returns the coordinates of an event at the map.
source code
 
get_world_location(self, evt) source code
 
mouseClicked(self, evt)
mouseClicked(IMouseListener self, MouseEvent evt)
source code
 
mouseEntered(self, evt)
mouseEntered(IMouseListener self, MouseEvent evt)
source code
 
mouseExited(self, evt)
mouseExited(IMouseListener self, MouseEvent evt)
source code
Class Variables [hide private]
  send_hover_instances_update = False

Inherited from fife.fife.IMouseListener: __del__, __swig_destroy__, thisown

    Inherited from selectiontool.SelectionTool
  _SELECTION_RECTANGLE_NAME = "_select"
    Inherited from navigationtool.NavigationTool
  HOVER_INSTANCES_UPDATE_DELAY = 1
  last_event_pos = fife.ScreenPoint(0, 0)
  last_hover_instances = WeakList()
    Inherited from cursortool.CursorTool
  log = logging.getLogger("gui.mousetools")
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, session)
(Constructor)

source code 

__init__(FIFE::IMouseListener self) -> IMouseListener

Overrides: object.__init__
(inherited documentation)

mousePressed(self, evt)

source code 

mousePressed(IMouseListener self, MouseEvent evt)

Overrides: fife.fife.IMouseListener.mousePressed
(inherited documentation)

mouseMoved(self, evt)

source code 

mouseMoved(IMouseListener self, MouseEvent evt)

Overrides: fife.fife.IMouseListener.mouseMoved
(inherited documentation)