Ignore:
Timestamp:
06/15/09 12:16:41 (11 years ago)
Author:
maximinus_parpg
Message:

One final tweak to the internal walls.
Epydoc'd world.py and sound.py.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/PARPG/scripts/sounds.py

    r140 r141  
    2020class SoundEngine: 
    2121    def __init__(self, fife_engine): 
     22        """Initialise the SoundEngine instance 
     23           @type fife_engine: fine.Engine 
     24           @param fife_engine: Instance of the Fife engine 
     25           @return: None""" 
    2226        self.engine = fife_engine 
    2327        self.sound_engine = self.engine.getSoundManager() 
     
    2933     
    3034    def playMusic(self, sfile = None): 
     35        """Play music, with the given file if passed 
     36           @type sfile: string 
     37           @param sfile: Filename to play 
     38           @return: None""" 
    3139        if(sfile != None): 
    3240            # setup the new sound 
     
    3947 
    4048    def pauseMusic(self): 
    41         """Stop current playback""" 
     49        """Stops current playback 
     50           @return: None""" 
    4251        if(self.music_init == True): 
    4352            self.music.pause() 
     
    4554 
    4655    def toggleMusic(self): 
     56        """Toggle status of music, either on or off 
     57           @return: None""" 
    4758        if((self.music_on == False)and(self.music_init == True)): 
    4859            self.playMusic() 
     
    5162 
    5263    def setVolume(self, volume): 
     64        """Set the volume of the music 
     65           @type volume: integer 
     66           @param volume: The volume wanted, 0 to 100 
     67           @return: None""" 
    5368        pass 
    5469 
Note: See TracChangeset for help on using the changeset viewer.