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

MUSHclient scripting

Description of MUSHclient world function: world.DoAfterSpeedWalk


Name DoAfterSpeedWalk
Type Method
Summary Adds a one-shot, temporary speedwalk timer - simplified interface
Prototype long DoAfterSpeedWalk(long Seconds, BSTR SendText)

View list of data type meanings

Description

This routine adds an unlabelled, temporary, one-shot speedwalk timer, set to go off after the designated number of seconds. The first argument (seconds) must evaluate to a time between 0.1 second, and 23 hours 59 minutes 59 seconds (that is, 0.1 to 86,399).

From version 3.61 onwards of MUSHclient the interval may include fractions (ie. it is a floating-point number). This lets you set up sub-second intervals (eg. 0.5 seconds, 1.2 seconds).

To enable this you need to go to Global Configuration -> Timers and set the 'Timer Interval' in seconds to zero.

The maximum granularity of the timers is currently 0.1 seconds. In other words, regardless of what you specify, the timers are only checked every 10th of a second.

You can also use DoAfter if you do not wish to speed walk, or DoAfterNote if you want to send a note to the output window.

The purpose of this is simplify the frequent case of simply wanting to do something in a few seconds, rather than using AddTimer.


WARNING - as DoAfterSpeedWalk is implemented by using temporary MUSHclient timers, it will not work if timers are disabled. If DoAfterSpeedWalk is not working for you (however the function call is returning zero) then ensure that timers are enabled in the Timers configuration dialog.


Note: Available in version 3.18 onwards.


VBscript example
world.DoAfterSpeedWalk 10, "5e 4s w"
Jscript example
world.DoAfterSpeedWalk (10, "5e 4s w");
PerlScript example
$world->DoAfterSpeedWalk (10, "5e 4s w");
Python example
world.DoAfterSpeedWalk (10, "5e 4s w")
Lua example
DoAfterSpeedWalk (10, "5e 4s w")
Returns eTimeInvalid: The time is invalid (seconds not in range 0.1 to 86,399).
eOK: added OK

View list of return code meanings

Introduced in version 3.18

See also ...

Function Description
AddTimer Adds a timer
DoAfter Adds a one-shot, temporary timer - simplified interface
DoAfterNote Adds a one-shot, temporary note timer - simplified interface
DoAfterSpecial Adds a one-shot, temporary, timer to carry out some special action

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]