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


Script function


Read about scripting




Returns the speedwalk string generated by the auto-mapper.


VARIANT GetMappingString();

View list of data type meanings


Returns the speedwalk string generated by the auto-mapper. This is a string that can be sent to EvaluateSpeedWalk to convert it into appropriate commands for sending to the MUD.

For example:

4s 2(ne/sw) e (ne/sw) 2n

If you want to get the reverse direction , send the supplied string to ReverseSpeedwalk.

VBscript example

world.note world.GetMappingString

Jscript example


PerlScript example


Python example


Lua example


Return value

The speedwalk string generated by the auto-mapper. It might be an empty string if there are no items in the auto-map sequence.

See Also ...


Speed walking


(AddMapperComment) Adds a comment to the auto-map sequence
(AddToMapper) Adds a mapping direction to the auto-map sequence
(DeleteAllMapItems) Deletes the all items from the auto-mapper sequence.
(DeleteLastMapItem) Deletes the most recently-added item from the auto-mapper sequence.
(EnableMapping) Enables or disables the auto-mapper
(EvaluateSpeedwalk) Evaluates a speed walk string
(GetMappingCount) Gets a count of the number of items in the auto-map sequence
(GetMappingItem) Gets one item from the auto-map sequence
(Mapping) A flag to indicate whether we are mapping the world
(RemoveMapReverses) A flag to indicate whether we backtracks are removed during mapping
(ReverseSpeedwalk) Reverses a speed walk string

(Help topic: function=GetMappingString)

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.


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]