PreloadMissionAudio: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | {{Server client function}} | ||
__NOTOC__ | |||
This function preloads a game sound into a specific sound slot. The sound can then be played with [[PlayMissionAudio]]. | This function preloads a game sound into a specific sound slot. The sound can then be played with [[PlayMissionAudio]]. | ||
==Usage== | ==Usage== | ||
Both server | Both server side and client side. '''thePlayer''' argument isn't used in client side version of this function. | ||
==Syntax== | ==Syntax== | ||
| Line 11: | Line 12: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''thePlayer''' | *'''thePlayer:''' the [[player]] you want to play the sound for. | ||
*'''sound''' | *'''sound:''' the [[int]] sound id to play (interpreted as unsigned short). Valid values are those from the '''data/AudioEvents.txt''' file. | ||
*'''slot''' | *'''slot:''' [[int]] sound slot in which you preloaded the sound. | ||
===Returns=== | ===Returns=== | ||
Revision as of 18:57, 16 August 2007
This function preloads a game sound into a specific sound slot. The sound can then be played with PlayMissionAudio.
Usage
Both server side and client side. thePlayer argument isn't used in client side version of this function.
Syntax
bool preloadMissionAudio ( player thePlayer, int sound, int slot )
Required Arguments
- thePlayer: the player you want to play the sound for.
- sound: the int sound id to play (interpreted as unsigned short). Valid values are those from the data/AudioEvents.txt file.
- slot: int sound slot in which you preloaded the sound.
Returns
Returns true if the sound was successfully preloaded, false otherwise.
Example
See PlayMissionAudio.
See Also