MUSHclient scripting

Description of MUSHclient world function: world.RemoveBacktracks

Name	RemoveBacktracks
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" Note: Available in 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"))`
Returns	`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.`
Introduced in version	3.48

See also ...

Function	Description
EvaluateSpeedwalk	Evaluates a speed walk string
ReverseSpeedwalk	Reverses a speed walk string

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.

Many functions return a "code" which indicates the success or otherwise of the function.

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

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