Module KX_SoundActuator :: Class KX_SoundActuator

Class KX_SoundActuator

SCA_ILogicBrick.SCA_ILogicBrick --+    
                                  |    
        SCA_IActuator.SCA_IActuator --+
                                      |
                                     KX_SoundActuator

Sound Actuator.

The startSound(), pauseSound() and stopSound() do not require the actuator to be activated - they act instantly.

Instance Methods

setFilename(filename)
Sets the filename of the sound this actuator plays.

source code

string

getFilename()
Returns the filename of the sound this actuator plays.

source code

setGain(gain)
Sets the gain (volume) of the sound

source code

float

getGain()
Gets the gain (volume) of the sound.

source code

setPitch(pitch)
Sets the pitch of the sound.

source code

float

getPitch()
Returns the pitch of the sound.

source code

setRollOffFactor(rolloff)
Sets the rolloff factor for the sounds.

source code

float

getRollOffFactor()
Returns the rolloff factor for the sound.

source code

setLooping(loop)
Sets the loop mode of the actuator.

source code

integer

getLooping()
Returns the current loop mode of the actuator.

source code

setPosition(x, y, z)
Sets the position this sound will come from.

source code

setVelocity(vx, vy, vz)
Sets the velocity this sound is moving at.

source code

setOrientation(o11, o12, o13, o21, o22, o23, o31, o32, o33)
Sets the orientation of the sound.

source code

setType(mode)
Sets the operation mode of the actuator.

source code

integer

getType()
Returns the operation mode of the actuator.

source code

Inherited from SCA_ILogicBrick.SCA_ILogicBrick: getExecutePriority, getOwner, setExecutePriority

Play Methods

startSound()
Starts the sound.

source code

pauseSound()
Pauses the sound.

source code

stopSound()
Stops the sound.

source code

Method Details

setFilename(filename)

source code

Sets the filename of the sound this actuator plays.

setGain(gain)

source code

Sets the gain (volume) of the sound

Parameters:

gain (float) - 0.0 (quiet) <= gain <= 1.0 (loud)

setPitch(pitch)

source code

Sets the pitch of the sound.

setRollOffFactor(rolloff)

source code

Sets the rolloff factor for the sounds.

Rolloff defines the rate of attenuation as the sound gets further away. Higher rolloff factors shorten the distance at which the sound can be heard.

setLooping(loop)

source code

Sets the loop mode of the actuator.

Parameters:

loop (integer) - - Play Stop 1
- Play End 2
- Loop Stop 3
- Loop End 4
- Bidirection Stop 5
- Bidirection End 6

Bug: There are no constants defined for this method!

setPosition(x, y, z)

source code

Sets the position this sound will come from.

Parameters:

x (float) - The x coordinate of the sound.
y (float) - The y coordinate of the sound.
z (float) - The z coordinate of the sound.

setVelocity(vx, vy, vz)

source code

Sets the velocity this sound is moving at.

The sound's pitch is determined from the velocity.

Parameters:

vx (float) - The vx coordinate of the sound.
vy (float) - The vy coordinate of the sound.
vz (float) - The vz coordinate of the sound.

setOrientation(o11, o12, o13, o21, o22, o23, o31, o32, o33)

source code

Sets the orientation of the sound.

The nine parameters specify a rotation matrix:

       | o11, o12, o13 |
       | o21, o22, o23 |
       | o31, o32, o33 |

setType(mode)

source code

Sets the operation mode of the actuator.

Parameters:

mode (integer) - KX_SOUNDACT_PLAYSTOP, KX_SOUNDACT_PLAYEND, KX_SOUNDACT_LOOPSTOP, KX_SOUNDACT_LOOPEND, KX_SOUNDACT_LOOPBIDIRECTIONAL, KX_SOUNDACT_LOOPBIDIRECTIONAL_STOP

getType()

source code

Returns the operation mode of the actuator.

Returns: integer: KX_SOUNDACT_PLAYSTOP, KX_SOUNDACT_PLAYEND, KX_SOUNDACT_LOOPSTOP, KX_SOUNDACT_LOOPEND, KX_SOUNDACT_LOOPBIDIRECTIONAL, KX_SOUNDACT_LOOPBIDIRECTIONAL_STOP