Script function

world.GetMappingString

Type

Method

Summary

Returns the speedwalk string generated by the auto-mapper.

Prototype

VARIANT GetMappingString();

Description

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

world.note(world.GetMappingString());

PerlScript example

$world->note($world->GetMappingString());

Python example

world.note(world.GetMappingString)

Lua example

Note(GetMappingString())

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

Topics

Aliases
Auto-mapper
Speed walking

Functions

(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)