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

MUSHclient scripting

Description of MUSHclient world function: world.GetMappingString


Name GetMappingString
Type Method
Summary Returns the speedwalk string generated by the auto-mapper.
Prototype VARIANT GetMappingString();

View list of 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())
Returns 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 ...

Function Description
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.
EvaluateSpeedwalk Evaluates a speed walk string
GetMappingCount Gets a count of the number of items in the auto-map sequence
GetMappingString Returns the speedwalk string generated by the auto-mapper.
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

Search for script function

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.

Search for:   

Leave blank to show all functions.


Return codes

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

You can view a list of the return codes


Function prototypes

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

You can view a list of the data types used in function prototypes


View all functions

[Back]

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]