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

RemoveBacktracks

Script function

world.RemoveBacktracks

Read about scripting

Type

Method

Summary

Removes backtracks from a speed walk string

Prototype

BSTR RemoveBacktracks(BSTR Path);

View list of data type meanings

Description

This takes a speedwalk as an argument and removes any backtracks from it.

For example: "4n 2s" would be converted to "2n".

A side-effect of this routine is that comments will be removed from speedwalks, and "reverse direction hints" will also be removed. eg. "(open door/close door) {comment}" would be converted to "(open door)".

It will also join directions where possible, eg. "n n n" would become "3n"


Available in MUSHclient version 3.48 onwards.



VBscript example

world.note world.RemoveBacktracks("4n 2s")


Jscript example

world.note(world.RemoveBacktracks("4n 2s"));


PerlScript example

$world->note($world->RemoveBacktracks("4n 2s"));


Python example

world.note(world.RemoveBacktracks("4n 2s"))


Lua example

Note(RemoveBacktracks("4n 2s"))


Return value

The supplied string, with the backtracks removed 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

Aliases
Auto-mapper
Getting started
Speed walking

Functions

(EvaluateSpeedwalk) Evaluates a speed walk string
(ReverseSpeedwalk) Reverses a speed walk string
(SpeedWalkDelay) The number of milliseconds delay between speed walk commands

(Help topic: function=RemoveBacktracks)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

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]