Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.Sound

Name Sound
Type Method
Summary Plays a sound
Prototype long Sound(BSTR SoundFileName);

View list of 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")
Returns eNoNameSpecified: no sound file name given
eCannotPlaySound: cannot play that file
eOK: completed OK

View list of return code meanings

See also ...

Function Description
GetSoundStatus Gets the status of a sound started by PlaySound
PlaySound Plays a sound using DirectSound
StopSound Stop playing a sound started by PlaySound

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes

View all functions

[Back]

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

Home