Home | Trees | Index | Help |
|
---|
Module KX_SoundActuator :: Class KX_SoundActuator |
|
SCA_ILogicBrick
--+ |SCA_IActuator
--+ | KX_SoundActuator
Sound Actuator.
ThestartSound()
, pauseSound()
and stopSound()
do not require the actuator to
be activated - they act instantly.
Method Summary | |
---|---|
string |
Returns the filename of the sound this actuator plays. |
float |
Gets the gain (volume) of the sound. |
integer |
Returns the current loop mode of the actuator. |
float |
Returns the pitch of the sound. |
float |
Returns the rolloff factor for the sound. |
integer |
Returns the operation mode of the actuator. |
Sets the filename of the sound this actuator plays. | |
Sets the gain (volume) of the sound | |
Sets the loop mode of the actuator. | |
Sets the orientation of the sound. | |
Sets the pitch of the sound. | |
Sets the position this sound will come from. | |
Sets the rolloff factor for the sounds. | |
Sets the operation mode of the actuator. | |
Sets the velocity this sound is moving at. | |
Play Methods | |
Starts the sound. | |
Pauses the sound. | |
Stops the sound. | |
Inherited from SCA_ILogicBrick | |
integer |
Gets the execution priority of this logic brick. |
KX_GameObject
|
Gets the game object associated with this logic brick. |
Sets the priority of this logic brick. |
Method Details |
---|
startSound()Starts the sound. |
pauseSound()Pauses the sound. |
stopSound()Stops the sound. |
getFilename()Returns the filename of the sound this actuator plays.
|
getGain()Gets the gain (volume) of the sound.
|
getLooping()Returns the current loop mode of the actuator.
|
getPitch()Returns the pitch of the sound.
|
getRollOffFactor()Returns the rolloff factor for the sound.
|
getType()Returns the operation mode of the actuator.
|
setFilename(filename)Sets the filename of the sound this actuator plays.
|
setGain(gain)Sets the gain (volume) of the sound
|
setLooping(loop)Sets the loop mode of the actuator.
|
setOrientation(o11, o12, o13, o21, o22, o23, o31, o32, o33)Sets the orientation of the sound. The nine parameters specify a rotation matrix:| o11, o12, o13 | | o21, o22, o23 | | o31, o32, o33 | |
setPitch(pitch)Sets the pitch of the sound.
|
setPosition(x, y, z)Sets the position this sound will come from.
|
setRollOffFactor(rolloff)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.
|
setType(mode)Sets the operation mode of the actuator.
|
setVelocity(vx, vy, vz)Sets the velocity this sound is moving at. The sound's pitch is determined from the velocity.
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.1 on Thu Feb 1 00:12:33 2007 | http://epydoc.sf.net |