pygsear.Event.EventGroup

Package pygsear :: Module Event :: Class EventGroup

[show private | hide private]

Class EventGroup

   object --+        
            |        
AbstractGroup --+    
                |    
            Group --+
                    |
                   EventGroup

Used to group related events.

Method Summary
	`__init__(self, event)` Initialize the Group.
	`add(self, event)` Add the event to the container.
	`check(self)` Go through the pygame event queue and callback to events that should be triggered.
	`disable(self)` Do not allow callbacks to any sprites in this group to go through.
	`enable(self)` Allow callbacks to all events in this group to go through.
	`events(self)` return a list of all events in this group.
	`kill(self)` Call the `kill` method on every event in this group, to remove all of the events from all of the groups they are in.
Inherited from AbstractGroup
	`__contains__(self, sprite)`
	`__iter__(self)`
	`__len__(self)` len(group) number of sprites in group
	`__nonzero__(self)`
	`__repr__(self)`
	`add_internal(self, sprite)`
	`clear(self, surface, bgd)` clear(surface, bgd) erase the previous position of all sprites
	`copy(self)` copy() copy a group with all the same sprites
	`draw(self, surface)` draw(surface) draw all sprites onto the surface
	`empty(self)` empty() remove all sprites
	`has(self, *sprites)` has(sprite or group, ...) ask if group has a sprite or sprites
	`has_internal(self, sprite)`
	`remove(self, *sprites)` remove(sprite, list, or group, ...) remove sprite from group
	`remove_internal(self, sprite)`
	`sprites(self)` sprites() get a list of sprites in the group
	`update(self, args)` update(args) call update for all member sprites
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, event=())
(Constructor)

Initialize the Group.

Parameters:: event - Event to add to the Group initially, or a sequence of events to add.

Overrides:: pygame.sprite.Group.__init__

add(self, event)

Add the event to the container.

Parameters:: event - Event to add, or a sequence of events to add.

Overrides:: pygame.sprite.AbstractGroup.add

check(self)

Go through the pygame event queue and callback to events that should be triggered.

Also checks the special TIMEOUT_Events queue, but only if any TIMEOUT_Events have been added to the group.

Note: This empties the queue.

disable(self)

Do not allow callbacks to any sprites in this group to go through.

enable(self)

Allow callbacks to all events in this group to go through.

events(self)

return a list of all events in this group.

kill(self)

Call the kill method on every event in this group, to remove all of the events from all of the groups they are in.

Generated by Epydoc 2.0 on Sat Dec 9 14:11:19 2006

http://epydoc.sf.net