Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.DiscardQueue


Name DiscardQueue
Type Method
Summary Discards the speed walk queue
Prototype long DiscardQueue();
Description

Discards any commands queued up, to be sent at the speedwalk delay interval.

The return value is the number of commands discarded.

VBscript example
world.discardqueue
Jscript example
world.discardqueue();
PerlScript example
$world->discardqueue();
Python example
world.discardqueue
Lua example
DiscardQueue()
Returns The number of commands discarded (might be zero).

See also ...

Function Description
GetQueue Returns a variant array which is a list of queued commands
Queue Queues a command for sending at the "speed walk" rate.
SpeedWalkDelay The number of milliseconds delay between speed walk commands

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.