Difference between revisions of "SoundCategory Script"
Jump to navigation
Jump to search
imported>Jlundin |
imported>Jog |
||
| Line 19: | Line 19: | ||
== Member Functions == | == Member Functions == | ||
'''Function [[Mute - SoundCategory|Mute]]()''' | |||
*Render inaudible any sounds in the given sound category. | |||
'''Function [[Pause - SoundCategory|Pause]]()''' | |||
*Pause any playing sounds in the given sound category. When restarted any stopped sounds will resume playing from the point at which they were paused. | |||
'''Function [[SetFrequency - SoundCategory|SetFrequency]](float afFrequencyCoeffecient)''' | |||
*Set a frequency modifier [0.0 - 1.0] for any sounds in this category | |||
'''Function [[SetVolume - SoundCategory|SetVolume]](float afVolume)''' | |||
*Set a volume modifier [0.0 - 1.0] for any sounds in this category | |||
'''Function [[UnMute - SoundCategory|UnMute]]()''' | |||
*Render audible sounds in the given sound category that were previously Muted. | |||
'''Function [[UnPause - SoundCategory|UnPause]]()''' | |||
*Play any sounds in the given sound category that are currently paused. | |||
== Events == | == Events == | ||
None | None | ||
Revision as of 13:05, 20 February 2012
Extends: Form Script
Script for the manipulation of sound category objects.
Definition
ScriptName SoundCategory extends FormProperties
None
Global Functions
None
Member Functions
Function Mute()
- Render inaudible any sounds in the given sound category.
Function Pause()
- Pause any playing sounds in the given sound category. When restarted any stopped sounds will resume playing from the point at which they were paused.
Function SetFrequency(float afFrequencyCoeffecient)
- Set a frequency modifier [0.0 - 1.0] for any sounds in this category
Function SetVolume(float afVolume)
- Set a volume modifier [0.0 - 1.0] for any sounds in this category
Function UnMute()
- Render audible sounds in the given sound category that were previously Muted.
Function UnPause()
- Play any sounds in the given sound category that are currently paused.
Events
None