Home | Trees | Indices | Help |
|
---|
|
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 provided that the actuator has been activated once at least.
Instance Methods | |||
|
|||
string |
|
||
|
|||
float |
|
||
|
|||
float |
|
||
|
|||
float |
|
||
|
|||
integer |
|
||
|
|||
|
|||
|
|||
|
|||
integer |
|
||
integer |
|
||
KX_GameObject |
|
||
|
|||
Play Methods | |||
---|---|---|---|
|
|||
|
|||
|
Instance Variables | |
int |
executePriority This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick) |
string |
filename Sets the filename of the sound this actuator plays. |
integer |
looping Sets the loop mode of the actuator. |
3x3 matrix [[float]] |
orientation Sets the orientation of the sound. |
KX_GameObject or None in exceptional cases. |
owner The game object this logic brick is attached to (read only). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick) |
float |
pitch Sets the pitch of the sound. |
float array |
position Sets the position of the sound. |
float |
rollOffFactor Sets the roll off factor. |
integer |
type Sets the operation mode of the actuator. |
float array |
velocity Sets the speed of the sound; The speed of the sound alter the pitch. |
float |
volume Sets the volume (gain) of the sound. |
Method Details |
DEPRECATED: Use the filename property instead. Sets the filename of the sound this actuator plays.
|
DEPRECATED: Use the filename property instead. Returns the filename of the sound this actuator plays.
|
DEPRECATED: Use the volume property instead Sets the gain (volume) of the sound
|
DEPRECATED: Use the volume property instead. Gets the gain (volume) of the sound.
|
DEPRECATED: Use the pitch property instead. Sets the pitch of the sound.
|
DEPRECATED: Use the pitch property instead. Returns the pitch of the sound.
|
DEPRECATED: Use the rollOffFactor property instead. 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.
|
DEPRECATED: Use the rollOffFactor property instead. Returns the rolloff factor for the sound.
|
DEPRECATED: Use the looping property instead. Sets the loop mode of the actuator.
Bug: There are no constants defined for this method! |
DEPRECATED: Use the looping property instead. Returns the current loop mode of the actuator.
|
DEPRECATED: Use the position property instead. Sets the position this sound will come from.
|
DEPRECATED: Use the velocity property instead. Sets the velocity this sound is moving at. The sound's pitch is determined from the velocity.
|
DEPRECATED: Use the orientation property instead. Sets the orientation of the sound. The nine parameters specify a rotation matrix: | o11, o12, o13 | | o21, o22, o23 | | o31, o32, o33 | |
DEPRECATED: Use the type property instead. Sets the operation mode of the actuator.
|
DEPRECATED: Use the type property instead. Returns the operation mode of the actuator.
|
Instance Variable Details |
orientationSets the orientation of the sound. When setting the orientation you can also use quaternion [float,float,float,float] or euler angles [float,float,float]
|
rollOffFactorSets the roll off factor. Rolloff defines the rate of attenuation as the sound gets further away.
|
typeSets the operation mode of the actuator. You can use one of the following constant:
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0 on Fri Apr 24 17:51:19 2009 | http://epydoc.sourceforge.net |