Table of Contents

Pyzzle Documation  

Pyzzle Documentation

Pyzzle Website

Note: until Pyzzle is at 1.0 the API may undergo small changes. Keep an eye on the changelog for details.

To do:

  • Finish the API documentation.
  • Write a line-by-line break down for the demo game.
  • Write a your 1st slide tut.
  • Write how to build your game into a window exe file tut.
  • Write a puzzle building tut.

I am looking into using epydoc for auto documentation generation. For now Happydoc will do.

API specification:

Note all below modules are imported automatically when pyzzle is imported.

Modules and Packages   

pyzzle

Base engine module.

enginecode/

AmbientSound

AmbientSound class module. Used for defining ambient sounds and music in the game.

Image

Image class module. Used for defining over-slide images.

Movie

Movie class module. Used for defining movies.

Object

Object class module. Used for defining objects to appear in the players object

Slide

Slide class module. Used for defining slides. The basic graphics unit.

Sound

Sound class module. Used for defining sound effects.

Text

Text class module. Used for defining over-slide text.

parameters

Parameters class module. Used for controlling and setting the global game parameters.

paths

Paths class module. Used for defining the default paths.

Table of Contents

This document was automatically generated on Tue Dec 3 16:55:38 2002 by HappyDoc version 2.1