extends Instance
Class fields
| Field | XML type | Value |
|---|---|---|
Name | string | SoundService |
ExplorerOrder | string | 50 |
ExplorerImageIndex | string | 31 |
Properties
4AmbientReverb
ReverbType| Field | XML type | Value |
|---|---|---|
Name | string | AmbientReverb |
summary | string | The ambient sound environment. May not work when using hardware sound |
DistanceFactor
float| Field | XML type | Value |
|---|---|---|
Name | string | DistanceFactor |
summary | string | the relative distance factor, compared to 1.0 meters. |
DopplerScale
float| Field | XML type | Value |
|---|---|---|
Name | string | DopplerScale |
summary | string | The doppler scale is a general scaling factor for how much the pitch varies due to doppler shifting in 3D sound. Doppler is the pitch bending effect when a sound comes towards the listener or moves away from it, much like the effect you hear when a train goes past you with its horn sounding. With dopplerscale you can exaggerate or diminish the effect. |
RolloffScale
float| Field | XML type | Value |
|---|---|---|
Name | string | RolloffScale |
summary | string | Setting this value makes the sound drop off faster or slower. The higher the value, the faster volume will attenuate, and conversely the lower the value, the slower it will attenuate. For example a rolloff factor of 1 will simulate the real world, where as a value of 2 will make sounds attenuate 2 times quicker. |
Functions
3GetListener
() → Tuple| Field | XML type | Value |
|---|---|---|
Name | string | GetListener |
PlayStockSound
(sound: SoundType) → void| Field | XML type | Value |
|---|---|---|
Name | string | PlayStockSound |
SetListener
(listenerType: ListenerType, listener: Tuple) → void| Field | XML type | Value |
|---|---|---|
Name | string | SetListener |