blender/source/gameengine/PyDoc/KX_CDActuator.py

33 lines
563 B
Python
Raw Normal View History

# $Id$
# Documentation for CD Actuator
from SCA_IActuator import *
class KX_CDActuator(SCA_IActuator):
def startCD():
"""
Starts the CD playing.
"""
def stopCD():
"""
Stops the CD playing.
"""
def pauseCD():
"""
Pauses the CD.
"""
def setGain(gain):
"""
Sets the gain (volume) of the CD.
@type gain: float
@param gain: the gain to set the CD to. 0.0 = silent, 1.0 = max volume.
"""
def getGain():
"""
Gets the current gain (volume) of the CD.
@rtype: float
@return: Between 0.0 (silent) and 1.0 (max volume)
"""