Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.ReverseSpeedwalk

Name ReverseSpeedwalk
Type Method
Summary Reverses a speed walk string
Prototype BSTR ReverseSpeedwalk(BSTR SpeedWalkString)

View list of data type meanings
Description

Reverses a supplied string based on the rules for "speed walking". See EvaluateSpeedwalk for a detailed description of those rules.

For example:

4n 3e s u w d LW

When reversed, this would become:

LE U E D N 3W 4S

If you supply a "special string" in parentheses, then the order of the words in parentheses is reversed. This lets you do special actions (eg. NE for NorthEast), and supply the reverse direction.

For example:

4n (se/nw)(in/out)

This would become:

(out/in) (nw/se) 4S
VBscript example 
world.note world.ReverseSpeedwalk ("4n3esuwdLW(ne/sw)")
Jscript example 
world.note(world.ReverseSpeedwalk ("4n3esuwdLW(ne/sw)"));
PerlScript example 
$world->note($world->ReverseSpeedwalk ("4n3esuwdLW(ne/sw)"));
Python example 
world.note(world.ReverseSpeedwalk ("4n3esuwdLW(ne/sw)"))
Lua example 
Note(ReverseSpeedwalk ("4n3esuwdLW(ne/sw)"))
Returns The supplied string, with the speedwalk directions reversed as described above.
If there is an error in the speed walk string then the first character of the returned string will be an asterisk ("*"), and the rest will be an English error message.

See also ...

Function Description
EvaluateSpeedwalk Evaluates a speed walk string
RemoveBacktracks Removes backtracks from a speed walk string

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