world.Sound

MUSHclient script function (Method)

Plays a sound

Prototype

long Sound(BSTR SoundFileName);

Data type meanings

Description

This plays the specified sound file, allowing you to add sound-effects to your world.

Also see PlaySound which lets you play multiple sound files at once.

The sound file should have the properties:

* "Wave" file (ie. ending in .wav)
* Audio sample size: 16 bit
* Channels: 2
* Audio sample rate: 22 kHz
* Audio format: PCM

You can use programs like Audacity (which is free) to convert sound files from one format to another.

http://audacity.sourceforge.net/

VBscript example

Sound "ding.wav"

Jscript example

Sound("ding.wav");

PerlScript example

$world->Sound("ding.wav");

Python example

world.Sound("ding.wav")

Lua example

Sound ("ding.wav")

Return value

eNoNameSpecified: no sound file name given
eCannotPlaySound: cannot play that file
eOK: completed OK

Return code meanings

Related topic

Utilities

See also