[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.StopSound


Name StopSound
Type Method
Summary Stop playing a sound started by PlaySound
Prototype long StopSound(short Buffer);

View list of data type meanings

Description

Stops one, or all, sound buffers from playing.

It is not necessary to call this for non-looping sounds, which stop of their own accord anyway, however doing so would free up the memory used by the sound.

The buffer argument specifies which buffer to stop (1 to 10) or 0 to stop all sound buffers playing.


Note: Available in version 4.28 onwards.


VBscript example
StopSound 0  ' Stop playing all sounds
StopSound 1 ' Stop playing sound buffer #1
Lua example
StopSound (0)  -- Stop playing all sounds
StopSound (1)  -- Stop playing sound buffer #1
Lua notes
The buffer number is optional and defaults to zero, which will stop all sounds from playing.
Returns eBadParameter: Buffer number outside range 0 to 10
eOK: Requested buffer(s) have been stopped.

View list of return code meanings

Introduced in version 4.28

See also ...

Function Description
GetSoundStatus Gets the status of a sound started by PlaySound
PlaySound Plays a sound using DirectSound
Sound Plays a sound

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]

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]