MUSHclient scripting

Description of MUSHclient world function: world.SpeedWalkDelay

Name	SpeedWalkDelay
Type	Property
Summary	The number of milliseconds delay between speed walk commands
Prototype	`short SpeedWalkDelay;` View list of data type meanings
Description	This property is used to retrieve, or set, the number of milliseconds which elapses between sending speed walk commands (or commands sent with the Queue method). The interval is in milliseconds. There are 1000 milliseconds to the second. The valid range for the speed walk delay is 0 to 30000 milliseconds (0 to 30 seconds). If the interval is zero, then commands are not queued, but are sent immediately, as fast as possible. Setting the interval to zero, when it was previously some other value, flushes any outstanding commands from the queue, so they are sent immediately.
VBscript example	`world.note world.SpeedWalkDelay ' display delay world.SpeedWalkDelay = 5000 ' make delay 5 seconds`
Jscript example	`world.note(world.SpeedWalkDelay); // display delay world.SpeedWalkDelay = 5000; // make delay 5 seconds`
PerlScript example	`$world->note ($world->{SpeedWalkDelay}); # display delay $world->{SpeedWalkDelay} = 5000; # make delay 5 seconds`
Python example	`world.note(world.SpeedWalkDelay) # display delay world.SpeedWalkDelay = 5000 # make delay 5 seconds`
Lua example	`Note (GetSpeedWalkDelay ()) -- display delay SetSpeedWalkDelay (5000) -- make delay 5 seconds`
Lua notes	`Lua implements this as two functions: GetSpeedWalkDelay - gets the speedwalk delay SetSpeedWalkDelay - sets the speedwalk delay`
Returns	`This is a property. You can review or change the number of milliseconds between sending speedwalk commands.`

See also ...

Function	Description
DiscardQueue	Discards the speed walk queue
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.

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

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