world.GetMappingString

MUSHclient script function (Method)

Returns the speedwalk string generated by the auto-mapper.

Prototype

VARIANT GetMappingString();

Data type meanings

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.

Related topic

Auto-mapper

See also