- fixed errors with bge epydocs
[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         @ivar gain: the gain (volume) of the CD between 0.0 and 1.0.
13         @type gain: float
14         """
15         def startCD():
16                 """
17                 Starts the CD playing.
18                 """
19         def stopCD():
20                 """
21                 Stops the CD playing.
22                 """
23         def pauseCD():
24                 """
25                 Pauses the CD.
26                 """
27         def resumeCD():
28                 """
29                 Resumes the CD after a pause.
30                 """
31         def playAll():
32                 """
33                 Plays the CD from the beginning.
34                 """
35         def playTrack(trackNumber):
36                 """
37                 Plays the track selected.
38                 """
39         def setGain(gain):
40                 """
41                 DEPRECATED: Use the volume property.
42                 Sets the gain (volume) of the CD.
43                 
44                 @type gain: float
45                 @param gain: the gain to set the CD to. 0.0 = silent, 1.0 = max volume.
46                 """
47         def getGain():
48                 """
49                 DEPRECATED: Use the volume property.
50                 Gets the current gain (volume) of the CD.
51                 
52                 @rtype: float
53                 @return: Between 0.0 (silent) and 1.0 (max volume)
54                 """
55