| audio_play(audio_name[, type_name[, blocking[, ignore_fade]]]) |
|
| Parameters: |
| audio_name | | (string) name of sound to play |
| type_name | | (string, optional) name of audio source (can be "foley", "voice", "music", or "ambient"; defaults to "foley") |
| blocking | | (boolean, optional) set to true to block until the sound starts playing, else set to false to return immediately (defaults to false) |
| ignore_fade | | (boolean, optional) set to true to ignore the volume throttling that occurs with screen fades (defaults to false) |
| |
| Returns: |
| (integer) audio instance handle, or -1 on error |
|
| Description: |
| Play a 2D sound (by name). Example: audio_play("Some Foley Sound", "foley") Plays the foley sound, "Some Foley Sound", in 2D. |
| |
|
| back to index | SR3 Script Action Documentation
Last updated: Tue, 09 Aug 2011 11:32:15 |