ffc8ddefa43344acc15cd697a7f76c9c55f816b6
[blender.git] / source / gameengine / PyDoc / KX_CDActuator.py
1 # $Id$
2 # Documentation for CD Actuator
3 from SCA_IActuator import *
4
5 class KX_CDActuator(SCA_IActuator):
6     """
7     CD Controller actuator.
8     @ivar volume: controls the volume to set the CD to. 0.0 = silent, 1.0 = max volume.
9     @type volume: float
10     @ivar track: the track selected to be played
11     @type track: integer
12     """
13         def startCD():
14                 """
15                 Starts the CD playing.
16                 """
17         def stopCD():
18                 """
19                 Stops the CD playing.
20                 """
21         def pauseCD():
22                 """
23                 Pauses the CD.
24                 """
25         def resumeCD():
26                 """
27                 Resumes the CD after a pause.
28                 """
29     def playAll():
30         """
31         Plays the CD from the beginning.
32         """
33     def playTrack(trackNumber):
34         """
35         Plays the track selected.
36         """
37         def setGain(gain):
38                 """
39         DEPRECATED: Use the volume property.
40                 Sets the gain (volume) of the CD.
41                 
42                 @type gain: float
43                 @param gain: the gain to set the CD to. 0.0 = silent, 1.0 = max volume.
44                 """
45         def getGain():
46                 """
47         DEPRECATED: Use the volume property.
48                 Gets the current gain (volume) of the CD.
49                 
50                 @rtype: float
51                 @return: Between 0.0 (silent) and 1.0 (max volume)
52                 """
53