[show private | hide private]
[frames | no frames]

## Module Hierarchy

- `pygsear`: Intended to provide a simpler, higher-level API for writing games using python and pygame.
  - `conf`: conf.py can be used as a shared "global" namespace
  - `Cursor`: Drawable objects which track the mouse.
  - `Drawable`: Things to show on the Pygame display.
  - `Event`: Keyboard and mouse event handling.
  - `Game`: Game is the central object.
  - `locals`
  - `Network`: Objects used for network communication using Twisted
  - `Path`: Ways for things to move around on screen
  - `Screen`: Interfaces with the Pygame display
  - `Sound`: Sounds
  - `Util`: Utilities for finding and loading different resources
  - `Widget`: Graphical input devices

## Class Hierarchy

- `__builtin__.object`: The most base type
  - `pygame.sprite.AbstractGroup`: A base for containers for sprites.
    - `pygame.sprite.Group`: The basic Group class you will want to use.
      - `pygsear.Event.EventGroup`: Used to group related events.
      - `pygame.sprite.RenderUpdates`: A sprite group that's more efficient at updating.
        - `pygsear.Drawable.Multi`: Made up of a group of sprites.
        - `pygsear.Drawable.SpriteGroup`: Specialized `pygame.sprite.Group` with more functionality.
  - `pygame.sprite.Sprite`: The base class for your visible game objects.
    - `pygsear.Drawable.Drawable`: Things to draw on screen.
      - `pygsear.Drawable.AnimatedImage`: Animated sprite using multiple images
        - `pygsear.Cursor.AnimatedCursor`: Sequence of images loaded from list of files
      - `pygsear.Drawable.Image`: Static sprite from image in a file
        - `pygsear.Cursor.ImageCursor`: Image loaded from file
      - `pygsear.Drawable.Layer`: Screen that can be used as a sprite
        - `pygsear.Widget.Dialog`
          - `pygsear.Widget.Dialog_OK`: Pop up a window to get some input.
            - `pygsear.Widget.Dialog_ColorSelector`: Used to choose a color interactively
            - `pygsear.Widget.Dialog_LineInput`: Used to get a single line of input
        - `pygsear.Game.GameConfiguration`: Used to configure the game
      - `pygsear.Drawable.Multi`: Made up of a group of sprites.
      - `pygsear.Drawable.MultiImage`: Multiple images from multiple files.
        - `pygsear.Cursor.MultiImageCursor`: Image loaded from file
        - `pygsear.Drawable.RotatedImage`: Sprite with auto-generated rotated images
          - `pygsear.Drawable.MultiRotated`: Sprite with multiple auto-generated rotated images
          - `pygsear.Drawable.Turtle`: Turtle-graphics-like object
            - `pygsear.Drawable.EuclidTurtle`: Turtle with altered co-ordinate system.
      - `pygsear.Widget.Score`: Keep and display a score or value.
      - `pygsear.Drawable.Shape`: Simple geometric shapes.
        - `pygsear.Drawable.Circle`: Circle.
          - `pygsear.Cursor.CircleCursor`: Circle shape
        - `pygsear.Drawable.Rectangle`: Rectangle, aligned with no rotation
          - `pygsear.Widget.ProgressBar`: Percentage bar graph.
            - `pygsear.Widget.VProgressBar`
          - `pygsear.Drawable.Square`: Square, aligned with no rotation.
            - `pygsear.Cursor.CrosshairCursor`: Like gun crosshairs
            - `pygsear.Cursor.XCursor`: X shape
      - `pygsear.Widget.SpriteButton`: Clickable button which is also a sprite.
        - `pygsear.Widget.ImageButton`
        - `pygsear.Widget.SpriteTextButton`: Clickable button which is also a sprite with text printed on it.
          - `pygsear.Widget.TextInput`: Used to gather text input from the user.
        - `pygsear.Widget.StationaryButton`: Clickable button which is a sprite but does not need to move.
          - `pygsear.Widget.CloseButton`: White square button with a black X.
          - `pygsear.Widget.StationaryTextButton`: Clickable button which is also a sprite with text printed on it and does not need to move.
      - `pygsear.Drawable.Stationary`: Drawable things which never move.
        - `pygsear.Widget.StationaryButton`: Clickable button which is a sprite but does not need to move.
          - `pygsear.Widget.CloseButton`: White square button with a black X.
          - `pygsear.Widget.StationaryTextButton`: Clickable button which is also a sprite with text printed on it and does not need to move.
      - `pygsear.Drawable.String`: A string of numbers, letters, or other characters.
    - `pygsear.Event.Event`: Relates Pygame Events with related actions.
      - `pygsear.Event.KEY_Event`: Keyboard events.
        - `pygsear.Event.KEYDOWN_Event`
        - `pygsear.Event.KEYUP_Event`
        - `pygsear.Event.Repeat_KEY_Event`: KEY_Event which will auto-repeat after a delay.
      - `pygsear.Event.MOUSEBUTTON_Event`: Mouse button events.
        - `pygsear.Event.MOUSEBUTTONDOWN_Event`
        - `pygsear.Event.MOUSEBUTTONUP_Event`
      - `pygsear.Event.QUIT_Event`
      - `pygsear.Event.TIMEOUT_Event`
    - `pygsear.Drawable.PSprite`
  - `__builtin__.type`: type(object) -> the object's type type(name, bases, dict) -> a new type
- `exceptions.Exception`: Common base class for all exceptions.
  - `pygsear.Cursor.AbstractClassError`
  - `pygsear.Path.EndOfPath`: Raise at the end of a path.
  - `pygsear.Util.TextRectException`
- `pygsear.Cursor.Cursor`
  - `pygsear.Cursor.AnimatedCursor`: Sequence of images loaded from list of files
  - `pygsear.Cursor.CircleCursor`: Circle shape
  - `pygsear.Cursor.CrosshairCursor`: Like gun crosshairs
  - `pygsear.Cursor.ImageCursor`: Image loaded from file
  - `pygsear.Cursor.MultiImageCursor`: Image loaded from file
  - `pygsear.Cursor.XCursor`: X shape
- `pygsear.Drawable.StationaryStack`: A Stack of Stationary Drawables.
- `pygsear.Game.GameLooper`: Abstract game control class
  - `pygsear.Game.Game`: The central game object.
    - `pygsear.Game.TwistedGame`: Alternate central game object using Twisted event loop
  - `pygsear.Game.GameConfiguration`: Used to configure the game
- `pygsear.Path.Path`: A set of points.
  - `pygsear.Path.BrownianPath`: Move in random directions
  - `pygsear.Path.ListPath`: Set of points fully created when instantiated.
    - `pygsear.Path.BrownianLinePath`: Line, with random motion superimposed.
    - `pygsear.Path.CirclePath`: Move in a circle.
      - `pygsear.Path.BounceCirclePath`: Move in a circle, reverse direction and go back.
    - `pygsear.Path.ConcentricCirclePath`: Circles one inside of the other.
    - `pygsear.Path.FigureEightPath`: Move in 2 connected circles, one clockwise, one ccw.
    - `pygsear.Path.FilePath`: Set of points retrieved from a file.
    - `pygsear.Path.LinePath`: Starts here, goes there, and stops.
      - `pygsear.Path.BounceLinePath`: Starts here, goes there, then goes back again.
    - `pygsear.Path.SquareEightPath`: Two squares, one clockwise, one couterclockwise.
    - `pygsear.Path.SquarePath`: Move in a square.
  - `pygsear.Path.Offset_path`: Follow another path, possibly moved over some.
  - `pygsear.Path.PathNG`: Next-generation Path
  - `pygsear.Path.RandomOnscreen`: Move to random locations on screen.
  - `pygsear.Path.StationaryPath`: For things that do not move, but need to be moved sometimes
  - `pygsear.Path.SuperPath`: Used to hold a series of other paths.
  - `pygsear.Path.TurtlePath`
  - `pygsear.Path.VelocityPath`: Move according to velocity in pixels per frame.
    - `pygsear.Path.AccelerationPath`: Move according to vel and accel in pixels per second.
    - `pygsear.Path.VelocityPathBounded`: VelocityPath with min/max x and y values.
      - `pygsear.Path.RandomAccelerationPathBounded`: Random motion, with set location limits.
      - `pygsear.Path.VelocityPathTimeBounded`: VelocityPathTime with min/max x and y values.
    - `pygsear.Path.VelocityPathTime`: Move according to velocity in pixels per second.
      - `pygsear.Path.RandomAccelerationPath`: Random motion.
        - `pygsear.Path.RandomAccelerationPathBounded`: Random motion, with set location limits.
      - `pygsear.Path.VelocityPathTimeBounded`: VelocityPathTime with min/max x and y values.
- `pygsear.Screen.Layer`: Holds foreground and background pygame surfaces
  - `pygsear.Drawable.Layer`: Screen that can be used as a sprite
    - `pygsear.Widget.Dialog`
      - `pygsear.Widget.Dialog_OK`: Pop up a window to get some input.
        - `pygsear.Widget.Dialog_ColorSelector`: Used to choose a color interactively
        - `pygsear.Widget.Dialog_LineInput`: Used to get a single line of input
    - `pygsear.Game.GameConfiguration`: Used to configure the game
  - `pygsear.Screen.Window`: This class interfaces with the Pygame display.
- `pygsear.Sound.DummySound`: Mock sound object, for when sound is not working.
- `pygsear.Widget.TextButton`: Clickable button with text printed on it.
  - `pygsear.Widget.SpriteTextButton`: Clickable button which is also a sprite with text printed on it.
    - `pygsear.Widget.TextInput`: Used to gather text input from the user.
  - `pygsear.Widget.StationaryTextButton`: Clickable button which is also a sprite with text printed on it and does not need to move.
- `pygsear.Widget.Widget`
  - `pygsear.Widget.Button`
    - `pygsear.Widget.SpriteButton`: Clickable button which is also a sprite.
      - `pygsear.Widget.ImageButton`
      - `pygsear.Widget.SpriteTextButton`: Clickable button which is also a sprite with text printed on it.
        - `pygsear.Widget.TextInput`: Used to gather text input from the user.
      - `pygsear.Widget.StationaryButton`: Clickable button which is a sprite but does not need to move.
        - `pygsear.Widget.CloseButton`: White square button with a black X.
        - `pygsear.Widget.StationaryTextButton`: Clickable button which is also a sprite with text printed on it and does not need to move.
  - `pygsear.Widget.Console`
  - `pygsear.Widget.Dialog`
    - `pygsear.Widget.Dialog_OK`: Pop up a window to get some input.
      - `pygsear.Widget.Dialog_ColorSelector`: Used to choose a color interactively
      - `pygsear.Widget.Dialog_LineInput`: Used to get a single line of input
  - `pygsear.Widget.EscCatcher`
  - `pygsear.Widget.ProgressBar`: Percentage bar graph.
    - `pygsear.Widget.VProgressBar`
  - `pygsear.Widget.Score`: Keep and display a score or value.
- `twisted.spread.jelly.Jellyable`: Inherit from me to Jelly yourself directly with the `getStateFor' convenience method.
  - `twisted.spread.flavors.Serializable`: An object that can be passed remotely.
    - `twisted.spread.flavors.Referenceable`
      - `twisted.spread.flavors.Root`: I provide a root object to `pb.Broker`s for a `pb.BrokerFactory`.
        - `pygsear.Network.TwoPlayerConnection`: Simple two player network connector
      - `pygsear.Network.TwoPlayerConnection`: Simple two player network connector

Generated by Epydoc 2.0 on Fri Nov 11 14:26:39 2005 | http://epydoc.sf.net