User Guide

HOW TO TRIGGER AUDIO

You can use the conditions and actions in the Multimedia section of the Script Builder’s lists to manage the

audio in your map. The following conditions and actions are useful.

PLAYING SOUND

✯

[Multimedia] Play a speech file: Use this action to play back a speech file. Select a speech file from the

drop-down list. To hear a preview, click PREVIEW SOUND. You can select whether to allow sound

overlap. If it is set to FALSE, all other scripted audio gets turned off as it plays. You can use that flag to

ensure that mission-critical voice-over is heard by the user.

NOTE: Never rely on speech to be the exclusive means by which players hear critical

information. Always back up any mission-critical audio with text messages on the screen.

SETTING AUDIO VOLUME

✯

[Multimedia] Set the current sound volume: This action sets the basic sound volume. It can be

overridden by other scripted actions.

✯

[Multimedia] Sound Events - Override volume – type: Use this action to play back a selected sound at

a selected volume. You can set volumes to be greater than 100%.

✯

[Multimedia] Sound Events - reset volume - all: This action restores the volume of all sound types to

their default levels.

✯

[Multimedia] Sound Events - reset volume - type: This action restores the volume of a specified sound

type to its default levels.

✯

[Multimedia] Sound Events - disable type: Disables playback of a specified sound type.

✯

[Multimedia] Pause the ambient sounds: This action pauses the playback of ambient sound, which is

useful if the user needs to hear very important audio.

SETTING AUDIO CONDITIONS

The triggering of audio is often based on user action or a timer. You can test whether audio has finished

playback to execute scripts with the following conditions.

✯

[Multimedia] Speech has completed playing: This condition tests whether a specified speech file has

completed playback.

✯

[Multimedia] Sound has completed playing: This condition tests whether a specified sound file has

completed playback.

✯

[Multimedia] Music Track has completed some number of times: Use this condition to test whether a

specified music track has played a specified number of times. Use this condition only for triggering

another piece of music.