GetMappingString
Script function

world.GetMappingString

DOC_scripting Read about scripting

Type

Method

Summary

Returns the speedwalk string generated by the auto-mapper.

Prototype

VARIANT GetMappingString();

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


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

DOC_aliases Aliases
DOC_mapper Auto-mapper
DOC_speed_walking Speed walking

Functions

FNC_AddMapperComment AddMapperComment (Adds a comment to the auto-map sequence)
FNC_AddToMapper AddToMapper (Adds a mapping direction to the auto-map sequence)
FNC_DeleteAllMapItems DeleteAllMapItems (Deletes the all items from the auto-mapper sequence.)
FNC_DeleteLastMapItem DeleteLastMapItem (Deletes the most recently-added item from the auto-mapper sequence.)
FNC_EnableMapping EnableMapping (Enables or disables the auto-mapper)
FNC_EvaluateSpeedwalk EvaluateSpeedwalk (Evaluates a speed walk string)
FNC_GetMappingCount GetMappingCount (Gets a count of the number of items in the auto-map sequence)
FNC_GetMappingItem GetMappingItem (Gets one item from the auto-map sequence)
FNC_GetMappingString GetMappingString (Returns the speedwalk string generated by the auto-mapper.)
FNC_Mapping Mapping (A flag to indicate whether we are mapping the world)
FNC_RemoveMapReverses RemoveMapReverses (A flag to indicate whether we backtracks are removed during mapping)
FNC_ReverseSpeedwalk ReverseSpeedwalk (Reverses a speed walk string)

(Help topic: function=GetMappingString)

DOC_contents Documentation contents page