Package pygsear :: Module Event :: Class Event
[show private | hide private]
[frames | no frames]

Class Event

object --+    
         |    
    Sprite --+
             |
            Event

Known Subclasses:
KEY_Event, MOUSEBUTTON_Event, QUIT_Event, TIMEOUT_Event

Relates Pygame Events with related actions.
Method Summary
  __init__(self, type, callback, **kwargs)
Initialize the event.
  add(self, group)
Add this Event to an EventGroup.
  call(self, pygame_event, **kwargs)
Perform the callback, if enabled.
  disable(self)
Do not allow callbacks to go through.
  enable(self)
Allow callbacks to go through.
  nop(self, ev, **kwargs)
Do nothing.
    Inherited from Sprite
  __repr__(self)
  add_internal(self, group)
  alive(self)
alive() -> bool check to see if the sprite is in any groups
  groups(self)
groups() -> list of groups list used sprite containers
  kill(self)
kill() remove this sprite from all groups
  remove(self, *groups)
remove(group or list of groups, ...) remove a sprite from container
  remove_internal(self, group)
  update(self, *args)
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)
    Inherited from type
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T

Method Details

__init__(self, type, callback=None, **kwargs)
(Constructor)

Initialize the event.
Parameters:
type - pygame.event type. Currently this includes KEYDOWN, KEYUP, MOUSEBUTTONDOWN, MOUSEBUTTONUP, and QUIT
callback - Function or method to call when the event occurs.
kwargs - Additional parameters that should be passed on to the callback.
Overrides:
pygame.sprite.Sprite.__init__

add(self, group)

Add this Event to an EventGroup.
Overrides:
pygame.sprite.Sprite.add

call(self, pygame_event, **kwargs)

Perform the callback, if enabled.
Parameters:
pygame_event - The actual pygame.event.Event that triggered this Event.
kwargs - Additional parameters that should be passed on to the callback. Note that keyword args included here will overwrite those added at the creation of the event.

disable(self)

Do not allow callbacks to go through.

enable(self)

Allow callbacks to go through.

nop(self, ev, **kwargs)

Do nothing.

Generated by Epydoc 2.0 on Sat Dec 9 14:11:19 2006 http://epydoc.sf.net