Module GameTypes :: Class KX_CDActuator

Class KX_CDActuator

PyObjectPlus --+            
               |            
          CValue --+        
                   |        
     SCA_ILogicBrick --+    
                       |    
           SCA_IActuator --+
                           |
                          KX_CDActuator

CD Controller actuator.

Instance Methods

[hide private]

startCD()
Starts the CD playing.

source code

stopCD()
Stops the CD playing.

source code

pauseCD()
Pauses the CD.

source code

resumeCD()
Resumes the CD after a pause.

source code

playAll()
Plays the CD from the beginning.

source code

playTrack(trackNumber)
Plays the track selected.

source code

Deprecated

setGain(gain)
Sets the gain (volume) of the CD.

source code

float

getGain()
Gets the current gain (volume) of the CD.

source code

Inherited from SCA_ILogicBrick

integer

getExecutePriority()
Gets the execution priority of this logic brick.

source code

KX_GameObject

getOwner()
Gets the game object associated with this logic brick.

source code

setExecutePriority(priority)
Sets the priority of this logic brick.

source code

Inherited from CValue

string

getName()
Returns the name of the CValue.

source code

Inherited from PyObjectPlus

bool

isA(game_type)
Check if this is a type or a subtype game_type.

source code

Instance Variables

[hide private]

float

gain
the gain (volume) of the CD between 0.0 and 1.0.

integer

track
the track selected to be played

float

volume
controls the volume to set the CD to.

Inherited from SCA_ILogicBrick

int

executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first).

string

name
The name of this CValue derived object (read-only).

KX_GameObject or None in exceptional cases.

owner
The game object this logic brick is attached to (read-only).

Inherited from PyObjectPlus

bool

invalid
Test if the object has been freed by the game engine and is no longer valid.

Method Details

[hide private]

setGain(gain)

source code

Sets the gain (volume) of the CD.

Parameters:

gain (float) - the gain to set the CD to. 0.0 = silent, 1.0 = max volume.

Deprecated: Use the volume property.

getGain()

source code

Gets the current gain (volume) of the CD.

Returns: float: Between 0.0 (silent) and 1.0 (max volume)

Deprecated: Use the volume property.

Instance Variable Details

[hide private]

volume

controls the volume to set the CD to. 0.0 = silent, 1.0 = max volume.

Type:: float