Audio - Meteor 2 Scripting Functions

void playSound(string soundName)

Play a sound locally without spatialisation.

playSound("world\\battle");

void playSoundNumber(string soundName, instanceID soundName)

Play a sound by number (faster) locally without spatialisation and support instanceID (looping).

int rainSoundNumber = -1;

void storeSoundNumbers()
{
    rainSoundNumber = getSoundNumber("ambience\\Rain_A");
}

void onWorldsStart()
{
    storeSoundNumbers();
}

void onGameLoad()
{
    storeSoundNumbers();
}

void onUpdate(float deltaTime)
{
    playSoundNumber(rainSoundNumber, "AMB_RAIN_SOUND");
}

Pass instanceID as "" to play a one shot sound.
Pass instanceID as a unique string and call playSoundNumber every frame to play a loop (stop calling to stop the sound).

playSound playSoundDelayed playSound2D playSoundNumber2D getSoundNumber

void playSoundDelayed(string soundName, float delayInSeconds)

Play a sound locally without spatialisation after a specified delay in seconds.

// play sound after 2 seconds
playSoundDelayed("world\\battle", 2);

playSound playSound2D

void playSound2D(vector2 pos, string soundName)

Play a one shot sound from a 2D position.

playSound2D(getPos(PLAYER_OBJECT), "world\\battle");

If run from the server the sound is also played on all clients.
If run from a client the sound is local only.

playSound playSoundNumber2D

void playSoundNumber2D(vector2 pos, int soundNumber, string instanceID)

Play a sound by number (faster) from a 2D position and support instanceID (looping).

int soundNumber = getSoundNumber("world\\battle");
if(soundNumber != -1)
playSoundNumber2D(getPos(PLAYER_OBJECT), soundNumber, "");

If run from the server the sound is also played on all clients.
If run from a client the sound is local only.
Pass instanceID as "" to play a one shot sound.
Pass instanceID as a unique string and call playSoundNumber2D every frame to play a loop (stop calling to stop the sound).

getSoundNumber playSound playSoundNumber playSound2D

void getSoundNumber(string effectName)

Get a sound number from a sound effect name.

int soundNumber = getSoundNumber("world\\battle");
print(soundNumber);

Returns -1 if the sound effect does not exist.

getSoundNumber playSound playSound2D

void playMusic(string musicFileName)

Play music from file.

playMusic("1996.mod");

Pass a filename only to search in base\music.
Pass an absolute path to play from another location.
Supported formats include Ogg Vorbis, MOD, S3M, XM.

stopMusic restartMusic getMusicFilename setMusicPos

float getMusicPos()

Get the currently playing music position in seconds.

print(getMusicPos())

setMusicPos

void setMusicPos(float seconds)

Seek the currently playing music to the current position in seconds.

// jump to 30 seconds in
setMusicPos(30);

getMusicPos

string getMusicFilename()

Get the currently playing music filename.

print(getMusicFilename())