ReverseSpeedwalk
Script function

world.ReverseSpeedwalk

DOC_scripting Read about scripting

Type

Method

Summary

Reverses a speed walk string

Prototype

BSTR ReverseSpeedwalk(BSTR SpeedWalkString)

DOC_data_types 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)"))


Return value

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 ...

Topics

DOC_aliases Aliases
DOC_mapper Auto-mapper
DOC_starting Getting started
DOC_speed_walking Speed walking

Functions

FNC_EvaluateSpeedwalk EvaluateSpeedwalk (Evaluates a speed walk string)
FNC_RemoveBacktracks RemoveBacktracks (Removes backtracks from a speed walk string)
FNC_SpeedWalkDelay SpeedWalkDelay (The number of milliseconds delay between speed walk commands)

(Help topic: function=ReverseSpeedwalk)

DOC_contents Documentation contents page