Table of Contents

Module: parameters enginecode/parameters.py

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

Imported modules   
import pygame
from pygame.locals import *
Functions   
disableZipMode
getBackgroundColor
getDefaultTransition
getObjectArrayAlpha
getResolution
getScreenSize
getSlideSize
getZipMode
isFullScreen
isTestMode
isZipModeDisable
setBackgroundColor
setDefaultTransition
setFullScreen
setObjectArrayAlpha
setResolution
setScreenSize
setSlideSize
setTestMode
setZipMode
  disableZipMode 
disableZipMode ()

Call this if you do not want to use zipmode in your game.

  getBackgroundColor 
getBackgroundColor ()

-> color (R, G, B).

returns the set background colour.

  getDefaultTransition 
getDefaultTransition ()

-> transition

returns the default transition.

  getObjectArrayAlpha 
getObjectArrayAlpha ( low,  high )

-> (low, high)

returns the low, high alpha values of the object array.

  getResolution 
getResolution ()

-> integer. Range: 8 - 32.

returns the set resolution.

  getScreenSize 
getScreenSize ()

-> (x, y)

returns the set screen size.

  getSlideSize 
getSlideSize ()

-> (x, y)

returns the maximum slide size.

  getZipMode 
getZipMode ()

-> boolean.

returns true if the zipmode is currently on.

  isFullScreen 
isFullScreen ()

-> boolean

returns true if pyzzle is running in full screen mode.

  isTestMode 
isTestMode ()

-> boolean

returns true if pyzzle is running in testing mode.

  isZipModeDisable 
isZipModeDisable ()

-> booolean.

returns true if the zipmode is disabled.

  setBackgroundColor 
setBackgroundColor ( color )

Sets the colour of the background.

parameters:

color
(R, G, B) (integers, range: 0-255).

  setDefaultTransition 
setDefaultTransition ( transition='BEST' )

Sets the default transition. The transition 1st used by the player.

parameters:

'transition = 'BEST''
transition type choose from: None, BEST, FASTEST or NORMAL.

  setFullScreen 
setFullScreen ( fullscreen=1 )

Tells Pyzzle to use full screen. Defaults to full screen. Having Pyzzle run in a window is very useful for game building.

parameters:

fullscreen = 1
boolean flag.

  setObjectArrayAlpha 
setObjectArrayAlpha ( low,  high )

Sets the low (mouse out) and high (mouse over) alpha value. If you want the object array to vanish when the mouse is not over it set low to 0. parameters:

low
(integer , range: 0 - 255). Mouse out alpha value for the object array.
high
(integer , range: 0 - 255). Mouse over alpha value for the object array. Set to 255 for a complete opaque object array.

  setResolution 
setResolution ( resolution=24 )

Sets the amount of colors for the display to use. Defaults to 24.

parameters:

resolution = 24
resolution range: 8 - 32
  setScreenSize 
setScreenSize ( size )

Sets the screen size. Defaults to 800x600. If the players screen size cannot auto-change then SDL will try to emulate the correct size. State in your games documentation the minimum screen size required to run.

parameters:

size
(x, y) Screen size.

  setSlideSize 
setSlideSize ( size )

Sets the size of the largest slide. Slide can be smaller then this, but not bigger.

parameters:

size
(x, y) maximum slide size.

  setTestMode 
setTestMode ( testmode=0 )

Tells Pyzzle to run in testing mode. Defaults to off. Having Pyzzle run in testing mode enables a quick q key exit. It will enable other testing goodies in the future

parameters:

testmode = 0
boolean flag.

  setZipMode 
setZipMode ( zipmode=0 )

Sets zipmode to be on by when the game is started.

parameters:

zipmode = 0 boolean flag.


Table of Contents

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