Module KX_CDActuator :: Class KX_CDActuator
[frames | no frames]

Class KX_CDActuator

SCA_ILogicBrick --+    
                  |    
      SCA_IActuator --+
                      |
                     KX_CDActuator


Method Summary
float getGain()
Gets the current gain (volume) of the CD.
  pauseCD()
Pauses the CD.
  setGain(gain)
Sets the gain (volume) of the CD.
  startCD()
Starts the CD playing.
  stopCD()
Stops the CD playing.
    Inherited from SCA_ILogicBrick
integer getExecutePriority()
Gets the execution priority of this logic brick.
KX_GameObject getOwner()
Gets the game object associated with this logic brick.
  setExecutePriority(priority)
Sets the priority of this logic brick.

Method Details

getGain()

Gets the current gain (volume) of the CD.
Returns:
Between 0.0 (silent) and 1.0 (max volume)
           (type=float)

pauseCD()

Pauses the CD.

setGain(gain)

Sets the gain (volume) of the CD.
Parameters:
gain - the gain to set the CD to. 0.0 = silent, 1.0 = max volume.
           (type=float)

startCD()

Starts the CD playing.

stopCD()

Stops the CD playing.

Generated by Epydoc 2.1 on Thu Feb 1 00:12:33 2007 http://epydoc.sf.net