aom.scripting.xs.tr

Class Multimedia

Object

Multimedia

public class Multimedia
extends Object

This class provides a collection of Trigger commands concerning Multimedia: audio, video, images, ...

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Method Summary

Modifier and Type	Method and Description
void	trBlockAllAmbientSounds() Blocks all ambient sounds from this point forward.
void	trBlockAllSounds(bool excludeDialog) Blocks all sounds from playing from this point forward.
void	trFadeOutAllSounds(float duration) Fades out all sounds over a given duration.
void	trFadeOutMusic(float duration) Fades out current music over a given duration.
void	trMusicPlay(string filename, float volume, float duration) Plays the music file.
void	trMusicPlayCurrent() Plays the current music.
void	trMusicSetCurrentMusicSet() Sets the current music set.
void	trMusicSetMood(int moodID) Changes the music to mood associated with mood id.
void	trMusicStop() Stops the current music.
void	trPlayMovie(string fileName) Plays movies from a playlist in the AVI directory.
void	trPlayNextMusicTrack() Plays the next song in the music play list.
void	trShowImageDialog(string texture, string subtitle) Displays a custom image in a dialog, with a subtitle.
void	trSoundPlayDialog(string filename, float volume, int eventID, bool ignoreOnAbort, string subtitle, string portrait) Plays the sound associated with the filename.
void	trSoundPlayFN(string filename, float volume, int eventID, string subtitle, string portrait) Plays the sound associated with the filename.
void	trSoundPlayPaused(string filename, float volume, int eventID, string subtitle, string portrait) Plays the sound associated with the filename.
void	trSoundTimer(int milliseconds, int eventID) Creates a high performance sound timer and passes the eventID as data.
void	trUnBlockAllAmbientSounds() Unblocks all ambient sounds that were previously blocked from playing.
void	trUnblockAllSounds() Unblocks all sounds that were previously blocked from playing.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

trFadeOutAllSounds

public void trFadeOutAllSounds(float duration)

Fades out all sounds over a given duration.

trFadeOutMusic

public void trFadeOutMusic(float duration)

Fades out current music over a given duration.

trMusicPlay

public void trMusicPlay(string filename,
                        float volume,
                        float duration)

Plays the music file.

trMusicPlayCurrent

public void trMusicPlayCurrent()

Plays the current music.

trMusicSetCurrentMusicSet

public void trMusicSetCurrentMusicSet()

Sets the current music set.

trMusicSetMood

public void trMusicSetMood(int moodID)

Changes the music to mood associated with mood id.

trMusicStop

public void trMusicStop()

Stops the current music.

trPlayMovie

public void trPlayMovie(string fileName)

Plays movies from a playlist in the AVI directory. The filename needs an extension.

trPlayNextMusicTrack

public void trPlayNextMusicTrack()

Plays the next song in the music play list.

trShowImageDialog

public void trShowImageDialog(string texture,
                              string subtitle)

Displays a custom image in a dialog, with a subtitle.

trSoundPlayDialog

public void trSoundPlayDialog(string filename,
                              float volume,
                              int eventID,
                              bool ignoreOnAbort,
                              string subtitle,
                              string portrait)

Plays the sound associated with the filename.

trSoundPlayFN

public void trSoundPlayFN(string filename,
                          float volume,
                          int eventID,
                          string subtitle,
                          string portrait)

Plays the sound associated with the filename. A sound parameter from the trigger XML automatically adds volume 1 to the given sound.

trSoundPlayPaused

public void trSoundPlayPaused(string filename,
                              float volume,
                              int eventID,
                              string subtitle,
                              string portrait)

Plays the sound associated with the filename.

trSoundTimer

public void trSoundTimer(int milliseconds,
                         int eventID)

Creates a high performance sound timer and passes the eventID as data.

trUnBlockAllAmbientSounds

public void trUnBlockAllAmbientSounds()

Unblocks all ambient sounds that were previously blocked from playing.

trUnblockAllSounds

public void trUnblockAllSounds()

Unblocks all sounds that were previously blocked from playing.

trBlockAllAmbientSounds

public void trBlockAllAmbientSounds()

Blocks all ambient sounds from this point forward.

trBlockAllSounds

public void trBlockAllSounds(bool excludeDialog)

Blocks all sounds from playing from this point forward.